rangeray/php-cli-command

Библиотека для создания консольных команд

v1.0.6 2022-06-15 17:13 UTC

This package is auto-updated.

Last update: 2024-05-15 21:45:27 UTC


README

Функциональность библиотеки включает в себя:

  • регистрацию необходимых команд в приложении;
  • возможность установить название и описание каждой команды;
  • обработку ввода пользователя (парсинг аргументов и выявление имени команды, аргументов и параметров);
  • выполнение заданной логики с возможностью вывода в информации в консоль.

    Установка подключение

    composer require rangeray/php-cli-command
    

    Настройка

    use RR\PHP\CliCommand\Console\Application;
    

$application = new Application(); $application->addCommand(new MyCommand()); $application->run();

### Параметры

- аргументы запуска передаются в фигурных скобках через запятую в следующем формате:
    - одиночный аргумент: `{arg}`
    - несколько аргументов: `{arg1,arg2,arg3}` ИЛИ `{arg1} {arg2} {arg3}`
      ИЛИ `{arg1,arg2} {arg3}`

- параметры запуска передаются в квадратных скобках в следующем формате:
    - параметр с одним значением: `[name=value]`
    - параметр с несколькими значениями: `[name={value1,value2,value3}]`
  
Пример запуска команды:

$/usr/bin/php app.php command_name {verbose,overwrite} [log_file=app.log] {unlimited} [methods={create,update,delete}] [paginate=50] {log}