rikin5/cli

此软件包的最新版本(1.0.0)没有可用的许可信息。

用于创建 cli 命令的库

1.0.0 2021-01-25 16:58 UTC

This package is auto-updated.

Last update: 2024-09-27 15:09:56 UTC


README

用于创建 cli 命令的库

要生成自动加载器,请运行以下命令

composer dump-autoload

要使用此库,请使用以下命令

php bin/cli.php

启动参数通过括号和逗号分隔,以下格式传递

  • 单个参数:{arg}
  • 多个参数:{arg1,arg2,arg3} 或者 {arg1} {arg2} {arg3} 或者 {arg1,arg2} {arg3}
  • 启动参数通过方括号传递,以下格式
  • 单个值参数:[name=value]
  • 多个值参数:[name={value1,value2,value3}]

库的功能包括

  • 在应用程序中注册必要的命令;
  • 设置命令名称和描述、其参数和参数;
  • 处理传入的参数;
  • 执行指定的逻辑,并具有输出到控制台信息的能力

当任何命令带有 {help} 参数启动时,将输出命令描述和允许的传入参数和参数列表。

命令启动示例

$/usr/bin/php cli.php command_name {verbose,overwrite} [log_file=app.log]
{unlimited} [methods={create,update,delete}] [paginate=50] {log}
Called command: command_name
    Arguments:
        - verbose
        - overwrite
        - unlimited
        - log
    Options:
        - log_file
            - app.log
        - methods
            - create
            - update
            - delete
        - paginate
            - 50

要创建新的命令,需要在新命令的文件夹 Commands 中创建一个新的命令类,并继承抽象类 Command.php。之后,在类 CommandManager.php 的 register() 方法中注册它

示例

protected function register(): void 
{
    $this->bindTo("Cli\Commands\Sum", "sum");
}