Командная строка

Компонент командной строки Webman

Установка

composer require webman/console

Примечание
Следующие команды предназначены для webman/console v2.2 и выше. Если каких-то функций не хватает, обновите пакет.

Содержание

Генерация кода

• make:controller — Генерация класса контроллера
• make:model — Генерация класса модели из таблицы БД
• make:crud — Генерация полного CRUD (модель + контроллер + валидатор)
• make:middleware — Генерация класса промежуточного ПО
• make:command — Генерация класса консольной команды
• make:bootstrap — Генерация класса инициализации при запуске
• make:process — Генерация класса пользовательского процесса

Сборка и развёртывание

• build:phar — Упаковка проекта в PHAR-архив
• build:bin — Упаковка проекта в автономный исполняемый файл
• install — Запуск скрипта установки Webman

Служебные команды

• version — Отображение версии фреймворка Webman
• fix-disable-functions — Исправление отключённых функций в php.ini
• route:list — Отображение всех зарегистрированных маршрутов

Управление прикладными плагинами (app-plugin:*)

• app-plugin:create — Создание нового прикладного плагина
• app-plugin:install — Установка прикладного плагина
• app-plugin:uninstall — Удаление прикладного плагина
• app-plugin:update — Обновление прикладного плагина
• app-plugin:zip — Упаковка прикладного плагина в ZIP

Управление плагинами (plugin:*)

• plugin:create — Создание нового плагина Webman
• plugin:install — Установка плагина Webman
• plugin:uninstall — Удаление плагина Webman
• plugin:enable — Включение плагина Webman
• plugin:disable — Отключение плагина Webman
• plugin:export — Экспорт исходного кода плагина

Управление сервисом

• start — Запуск рабочих процессов Webman
• stop — Остановка рабочих процессов Webman
• restart — Перезапуск рабочих процессов Webman
• reload — Перезагрузка кода без простоя
• status — Просмотр статуса рабочих процессов
• connections — Получение информации о подключениях рабочих процессов

Генерация кода

make:controller

Генерация класса контроллера.

Использование:

php webman make:controller <name>

Аргументы:

Опции:

Примеры:

# Создать UserController в app/controller
php webman make:controller User

# Создать в плагине
php webman make:controller AdminUser -p admin

# Пользовательский путь
php webman make:controller User -P app/api/controller

# Перезаписать существующий файл
php webman make:controller User -f

# Создать без суффикса «Controller»
php webman make:controller UserHandler --no-suffix

Структура генерируемого файла:

<?php
namespace app\controller;

use support\Request;

class UserController
{
    public function index(Request $request)
    {
        return response('hello user');
    }
}

Примечания:

• По умолчанию контроллеры размещаются в app/controller/
• Суффикс контроллера из конфигурации добавляется автоматически
• При существовании файла запрашивается подтверждение перезаписи (аналогично для других команд)

make:model

Генерация класса модели из таблицы базы данных. Поддерживаются Laravel ORM и ThinkORM.

Использование:

php webman make:model [name]

Аргументы:

Опции:

Примечания по путям:

• По умолчанию: app/model/ (основное приложение) или plugin/<plugin>/app/model/ (плагин)
• --path указывается относительно корня проекта, например plugin/admin/app/model
• При одновременном использовании --plugin и --path они должны указывать на одну и ту же директорию

Примеры:

# Создать модель User в app/model
php webman make:model User

# Указать имя таблицы и ORM
php webman make:model User -t wa_users -o laravel

# Создать в плагине
php webman make:model AdminUser -p admin

# Пользовательский путь
php webman make:model User -P plugin/admin/app/model

Интерактивный режим: При отсутствии имени запускается интерактивный процесс: выбор таблицы → ввод имени модели → ввод пути. Поддерживается: Enter для просмотра дополнительных записей, 0 для создания пустой модели, /ключевое_слово для фильтрации таблиц.

Структура генерируемого файла:

<?php
namespace app\model;

use support\Model;

/**
 * @property integer $id (primary key)
 * @property string $name
 */
class User extends Model
{
    protected $connection = 'mysql';
    protected $table = 'users';
    protected $primaryKey = 'id';
    public $timestamps = true;
}

Аннотации @property генерируются автоматически на основе структуры таблицы. Поддерживаются MySQL и PostgreSQL.

make:crud

Генерация модели, контроллера и валидатора из таблицы БД за один шаг, формируя полную CRUD-функциональность.

Использование:

php webman make:crud

Опции:

Порядок выполнения: При неуказанном --table запускается интерактивный выбор таблицы; имя модели по умолчанию выводится из имени таблицы; имя контроллера по умолчанию — имя модели + суффикс контроллера; имя валидатора по умолчанию — имя контроллера без суффикса + Validator. Пути по умолчанию: модель app/model/, контроллер app/controller/, валидатор app/validation/; для плагинов — соответствующие поддиректории в plugin/<plugin>/app/.

Примеры:

# Интерактивная генерация (пошаговое подтверждение после выбора таблицы)
php webman make:crud

# Указать имя таблицы
php webman make:crud --table=users

# Указать имя таблицы и плагин
php webman make:crud --table=users --plugin=admin

# Указать пути
php webman make:crud --table=users --model-path=app/model --controller-path=app/controller

# Не генерировать валидатор
php webman make:crud --table=users --no-validator

# Неинтерактивный режим + перезапись
php webman make:crud --table=users --no-interaction --force

Структура генерируемых файлов:

Модель (app/model/User.php):

<?php

namespace app\model;

use support\Model;

class User extends Model
{
    protected $connection = 'mysql';
    protected $table = 'users';
    protected $primaryKey = 'id';
}

Контроллер (app/controller/UserController.php):

<?php

namespace app\controller;

use support\Request;
use support\Response;
use app\model\User;
use app\validation\UserValidator;
use support\validation\annotation\Validate;

class UserController
{
    #[Validate(validator: UserValidator::class, scene: 'create', in: ['body'])]
    public function create(Request $request): Response
    {
        $data = $request->post();
        $model = new User();
        foreach ($data as $key => $value) {
            $model->setAttribute($key, $value);
        }
        $model->save();
        return json(['code' => 0, 'msg' => 'ok', 'data' => $model]);
    }

    #[Validate(validator: UserValidator::class, scene: 'update', in: ['body'])]
    public function update(Request $request): Response
    {
        if (!$model = User::find($request->post('id'))) {
            return json(['code' => 1, 'msg' => 'not found']);
        }
        $data = $request->post();
        unset($data['id']);
        foreach ($data as $key => $value) {
            $model->setAttribute($key, $value);
        }
        $model->save();
        return json(['code' => 0, 'msg' => 'ok', 'data' => $model]);
    }

    #[Validate(validator: UserValidator::class, scene: 'delete', in: ['body'])]
    public function delete(Request $request): Response
    {
        if (!$model = User::find($request->post('id'))) {
            return json(['code' => 1, 'msg' => 'not found']);
        }
        $model->delete();
        return json(['code' => 0, 'msg' => 'ok']);
    }

    #[Validate(validator: UserValidator::class, scene: 'detail')]
    public function detail(Request $request): Response
    {
        if (!$model = User::find($request->input('id'))) {
            return json(['code' => 1, 'msg' => 'not found']);
        }
        return json(['code' => 0, 'msg' => 'ok', 'data' => $model]);
    }
}

Валидатор (app/validation/UserValidator.php):

<?php
declare(strict_types=1);

namespace app\validation;

use support\validation\Validator;

class UserValidator extends Validator
{
    protected array $rules = [
        'id' => 'required|integer|min:0',
        'username' => 'required|string|max:32'
    ];

    protected array $messages = [];

    protected array $attributes = [
        'id' => 'Первичный ключ',
        'username' => 'Имя пользователя'
    ];

    protected array $scenes = [
        'create' => ['username', 'nickname'],
        'update' => ['id', 'username'],
        'delete' => ['id'],
        'detail' => ['id'],
    ];
}

Примечания:

• Генерация валидатора пропускается, если webman/validation не установлен или не включён (установка: composer require webman/validation)
• Атрибуты attributes валидатора генерируются автоматически из комментариев полей БД; при отсутствии комментариев attributes не создаётся
• Сообщения об ошибках валидатора поддерживают интернационализацию; язык выбирается из config('translation.locale')

make:middleware

Генерация класса промежуточного ПО и автоматическая регистрация в config/middleware.php (или plugin/<plugin>/config/middleware.php для плагинов).

Использование:

php webman make:middleware <name>

Аргументы:

Опции:

Примеры:

# Создать промежуточное ПО Auth в app/middleware
php webman make:middleware Auth

# Создать в плагине
php webman make:middleware Auth -p admin

# Пользовательский путь
php webman make:middleware Auth -P plugin/admin/app/middleware

Структура генерируемого файла:

<?php
namespace app\middleware;

use Webman\MiddlewareInterface;
use Webman\Http\Response;
use Webman\Http\Request;

class Auth implements MiddlewareInterface
{
    public function process(Request $request, callable $handler) : Response
    {
        return $handler($request);
    }
}

Примечания:

• По умолчанию размещается в app/middleware/
• Имя класса автоматически добавляется в конфигурационный файл промежуточного ПО для активации

make:command

Генерация класса консольной команды.

Использование:

php webman make:command <command-name>

Аргументы:

Опции:

Примеры:

# Создать команду user:list в app/command
php webman make:command user:list

# Создать в плагине
php webman make:command user:list -p admin

# Пользовательский путь
php webman make:command user:list -P plugin/admin/app/command

# Перезаписать существующий файл
php webman make:command user:list -f

Структура генерируемого файла:

<?php

namespace app\command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand('user:list', 'user list')]
class UserList extends Command
{
    protected function configure(): void
    {
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $output->writeln('<info>Hello</info> <comment>' . $this->getName() . '</comment>');
        return self::SUCCESS;
    }
}

Примечания:

• По умолчанию размещается в app/command/

make:bootstrap

Генерация класса инициализации при запуске. Метод start вызывается автоматически при запуске процесса, обычно для глобальной инициализации.

Использование:

php webman make:bootstrap <name>

Аргументы:

Опции:

Примеры:

# Создать MyBootstrap в app/bootstrap
php webman make:bootstrap MyBootstrap

# Создать без автоматического включения
php webman make:bootstrap MyBootstrap no

# Создать в плагине
php webman make:bootstrap MyBootstrap -p admin

# Пользовательский путь
php webman make:bootstrap MyBootstrap -P plugin/admin/app/bootstrap

# Перезаписать существующий файл
php webman make:bootstrap MyBootstrap -f

Структура генерируемого файла:

<?php

namespace app\bootstrap;

use Webman\Bootstrap;

class MyBootstrap implements Bootstrap
{
    public static function start($worker)
    {
        $is_console = !$worker;
        if ($is_console) {
            return;
        }
        // ...
    }
}

Примечания:

• По умолчанию размещается в app/bootstrap/
• При включении класс добавляется в config/bootstrap.php (или plugin/<plugin>/config/bootstrap.php для плагинов)

make:process

Генерация класса пользовательского процесса и запись в config/process.php для автоматического запуска.

Использование:

php webman make:process <name>

Аргументы:

Опции:

Примеры:

# Создать в app/process
php webman make:process MyTcp

# Создать в плагине
php webman make:process MyProcess -p admin

# Пользовательский путь
php webman make:process MyProcess -P plugin/admin/app/process

# Перезаписать существующий файл
php webman make:process MyProcess -f

Интерактивный процесс: Последовательно запрашивается: прослушивать порт? → тип протокола (websocket/http/tcp/udp/unixsocket) → адрес прослушивания (IP:порт или путь unix socket) → количество процессов. Для протокола HTTP дополнительно запрашивается встроенный или пользовательский режим.

Структура генерируемого файла:

Непрослушивающий процесс (только onWorkerStart):

<?php
namespace app\process;

use Workerman\Worker;

class MyProcess
{
    public function onWorkerStart(Worker $worker)
    {
        // TODO: Write your business logic here.
    }
}

Процессы с прослушиванием TCP/WebSocket генерируют соответствующие шаблоны обратных вызовов onConnect, onMessage, onClose.

Примечания:

• По умолчанию размещается в app/process/; конфигурация процесса записывается в config/process.php
• Ключ конфигурации — snake_case от имени класса; при уже существующем ключе выполнение завершается с ошибкой
• Встроенный режим HTTP использует файл процесса app\process\Http, новый файл не создаётся
• Поддерживаемые протоколы: websocket, http, tcp, udp, unixsocket

Сборка и развёртывание

build:phar

Упаковка проекта в PHAR-архив для распространения и развёртывания.

Использование:

php webman build:phar

Запуск:

Перейдите в директорию сборки и выполните

php webman.phar start

Примечания:

• Упакованный проект не поддерживает reload; для обновления кода используйте restart

• Чтобы избежать большого размера файла и потребления памяти, настройте exclude_pattern и exclude_files в config/plugin/webman/console/app.php для исключения ненужных файлов.

• При запуске webman.phar в том же каталоге создаётся директория runtime для логов и временных файлов.

• Если проект использует файл .env, поместите .env в тот же каталог, что и webman.phar.

• webman.phar не поддерживает пользовательские процессы в Windows

• Никогда не храните загруженные пользователем файлы внутри phar-пакета; работа с пользовательскими загрузками через phar:// опасна (уязвимость десериализации phar). Загруженные пользователем файлы должны храниться отдельно на диске вне phar. См. ниже.

• Если требуется загрузка файлов в публичную директорию, извлеките публичную директорию в тот же каталог, что и webman.phar, и настройте config/app.php:

  'public_path' => base_path(false) . DIRECTORY_SEPARATOR . 'public',

  Используйте вспомогательную функцию public_path($relative_path) для получения фактического пути к публичной директории.

build:bin

Упаковка проекта в автономный исполняемый файл со встроенной средой выполнения PHP. Установка PHP в целевой среде не требуется.

Использование:

php webman build:bin [version]

Аргументы:

Примеры:

# Использовать текущую версию PHP
php webman build:bin

# Указать PHP 8.2
php webman build:bin 8.2

Запуск:

Перейдите в директорию сборки и выполните

./webman.bin start

Примечания:

• Настоятельно рекомендуется: локальная версия PHP должна совпадать с версией сборки (например, локально PHP 8.1 → сборка с 8.1) во избежание проблем совместимости
• Сборка загружает исходный код PHP 8, но не устанавливает его локально; локальная среда PHP не затрагивается
• webman.bin в настоящее время работает только на x86_64 Linux; на macOS не поддерживается
• Упакованный проект не поддерживает reload; для обновления кода используйте restart
• .env по умолчанию не упаковывается (управляется exclude_files в config/plugin/webman/console/app.php); поместите .env в тот же каталог, что и webman.bin, при запуске
• В каталоге webman.bin создаётся директория runtime для файлов логов
• webman.bin не читает внешний php.ini; для пользовательских настроек php.ini используйте custom_ini в config/plugin/webman/console/app.php
• Исключите ненужные файлы через config/plugin/webman/console/app.php, чтобы избежать большого размера пакета
• Сборка в бинарный файл не поддерживает корутины Swoole
• Никогда не храните загруженные пользователем файлы внутри бинарного пакета; работа через phar:// опасна (уязвимость десериализации phar). Загруженные пользователем файлы должны храниться отдельно на диске вне пакета.
• Если требуется загрузка файлов в публичную директорию, извлеките публичную директорию в тот же каталог, что и webman.bin, и настройте config/app.php как указано ниже, затем пересоберите:

  'public_path' => base_path(false) . DIRECTORY_SEPARATOR . 'public',

install

Выполнение скрипта установки фреймворка Webman (вызов \Webman\Install::install()), для инициализации проекта.

Использование:

php webman install

Служебные команды

version

Отображение версии workerman/webman-framework.

Использование:

php webman version

Примечания: Версия читается из vendor/composer/installed.php; при невозможности чтения возвращается ошибка.

fix-disable-functions

Исправление disable_functions в php.ini, удаление функций, необходимых для работы Webman.

Использование:

php webman fix-disable-functions

Примечания: Удаляет следующие функции (и совпадения по префиксу) из disable_functions: stream_socket_server, stream_socket_accept, stream_socket_client, pcntl_*, posix_*, proc_*, shell_exec, exec. Пропускается, если php.ini не найден или disable_functions пуст. Напрямую изменяет файл php.ini; рекомендуется предварительная резервная копия.

route:list

Отображение всех зарегистрированных маршрутов в табличном формате.

Использование:

php webman route:list

Пример вывода:

+-------+--------+-----------------------------------------------+------------+------+
| URI   | Method | Callback                                      | Middleware | Name |
+-------+--------+-----------------------------------------------+------------+------+
| /user | GET    | ["app\\controller\\UserController","index"] | null       |      |
| /api  | POST   | Closure                                      | ["Auth"]   | api  |
+-------+--------+-----------------------------------------------+------------+------+

Столбцы вывода: URI, Method, Callback, Middleware, Name. Обратные вызовы-замыкания отображаются как «Closure».

Управление прикладными плагинами (app-plugin:*)

app-plugin:create

Создание нового прикладного плагина с полной структурой директорий и базовыми файлами в plugin/<name>.

Использование:

php webman app-plugin:create <name>

Аргументы:

Примеры:

# Создать прикладной плагин с именем foo
php webman app-plugin:create foo

# Создать плагин с дефисом
php webman app-plugin:create my-app

Структура генерируемых директорий:

plugin/<name>/
├── app/
│   ├── controller/IndexController.php
│   ├── model/
│   ├── middleware/
│   ├── view/index/index.html
│   └── functions.php
├── config/          # app.php, route.php, menu.php и т.д.
├── api/Install.php  # Хуки установки/удаления/обновления
├── public/
└── install.sql

Примечания:

• Плагин создаётся в plugin/<name>/; при уже существующей директории выполнение завершается с ошибкой

app-plugin:install

Установка прикладного плагина, выполнение plugin/<name>/api/Install::install($version).

Использование:

php webman app-plugin:install <name>

Аргументы:

Примеры:

php webman app-plugin:install foo

app-plugin:uninstall

Удаление прикладного плагина, выполнение plugin/<name>/api/Install::uninstall($version).

Использование:

php webman app-plugin:uninstall <name>

Аргументы:

Опции:

Примеры:

php webman app-plugin:uninstall foo
php webman app-plugin:uninstall foo -y

app-plugin:update

Обновление прикладного плагина, последовательное выполнение Install::beforeUpdate($from, $to) и Install::update($from, $to, $context).

Использование:

php webman app-plugin:update <name>

Аргументы:

Опции:

Примеры:

php webman app-plugin:update foo
php webman app-plugin:update foo --from 1.0.0 --to 1.1.0

app-plugin:zip

Упаковка прикладного плагина в ZIP-файл, вывод в plugin/<name>.zip.

Использование:

php webman app-plugin:zip <name>

Аргументы:

Примеры:

php webman app-plugin:zip foo

Примечания:

• Автоматически исключаются node_modules, .git, .idea, .vscode, __pycache__ и т.д.

Управление плагинами (plugin:*)

plugin:create

Создание нового плагина Webman (в форме пакета Composer), генерация конфигурационной директории config/plugin/<name> и директории исходного кода плагина vendor/<name>.

Использование:

php webman plugin:create <name>
php webman plugin:create --name <name>

Аргументы:

Примеры:

php webman plugin:create foo/my-admin
php webman plugin:create --name foo/my-admin

Генерируемая структура:

• config/plugin/<name>/app.php: конфигурация плагина (включая переключатель enable)
• vendor/<name>/composer.json: определение пакета плагина
• vendor/<name>/src/: директория исходного кода плагина
• Автоматическое добавление PSR-4-маппинга в корневой composer.json проекта
• Выполнение composer dumpautoload для обновления автозагрузки

Примечания:

• Имя должно быть в формате vendor/package: строчные буквы, цифры, -, _, ., и обязательно содержать один /
• При уже существующих config/plugin/<name> или vendor/<name> выполнение завершается с ошибкой
• Ошибка при одновременной передаче аргумента и --name с разными значениями

plugin:install

Выполнение скрипта установки плагина (Install::install()), копирование ресурсов плагина в директорию проекта.

Использование:

php webman plugin:install <name>
php webman plugin:install --name <name>

Аргументы:

Опции:

Примеры:

php webman plugin:install foo/my-admin
php webman plugin:install --name foo/my-admin

plugin:uninstall

Выполнение скрипта удаления плагина (Install::uninstall()), удаление ресурсов плагина из проекта.

Использование:

php webman plugin:uninstall <name>
php webman plugin:uninstall --name <name>

Аргументы:

Опции:

Примеры:

php webman plugin:uninstall foo/my-admin

plugin:enable

Включение плагина, установка enable в true в config/plugin/<name>/app.php.

Использование:

php webman plugin:enable <name>
php webman plugin:enable --name <name>

Аргументы:

Опции:

Примеры:

php webman plugin:enable foo/my-admin

plugin:disable

Отключение плагина, установка enable в false в config/plugin/<name>/app.php.

Использование:

php webman plugin:disable <name>
php webman plugin:disable --name <name>

Аргументы:

Опции:

Примеры:

php webman plugin:disable foo/my-admin

plugin:export

Экспорт конфигурации плагина и указанных директорий из проекта в vendor/<name>/src/ с генерацией Install.php для упаковки и распространения.

Использование:

php webman plugin:export <name> [--source=path]...
php webman plugin:export --name <name> [--source=path]...

Аргументы:

Опции:

Примеры:

# Экспорт плагина, по умолчанию включает config/plugin/<name>
php webman plugin:export foo/my-admin

# Дополнительный экспорт app, config и т.д.
php webman plugin:export foo/my-admin --source app --source config
php webman plugin:export --name foo/my-admin -s app -s config

Примечания:

• Имя плагина должно соответствовать соглашению об именовании пакетов Composer (vendor/package)
• Если config/plugin/<name> существует и не указан в --source, он автоматически добавляется в список экспорта
• Экспортируемый Install.php содержит pathRelation для использования в plugin:install / plugin:uninstall
• Для plugin:install и plugin:uninstall требуется наличие плагина в vendor/<name>, класса Install и константы WEBMAN_PLUGIN

Управление сервисом

start

Запуск рабочих процессов Webman. По умолчанию режим DEBUG (передний план).

Использование:

php webman start

Опции:

stop

Остановка рабочих процессов Webman.

Использование:

php webman stop

Опции:

restart

Перезапуск рабочих процессов Webman.

Использование:

php webman restart

Опции:

reload

Перезагрузка кода без простоя. Для горячей перезагрузки после обновления кода.

Использование:

php webman reload

Опции:

status

Просмотр статуса работы рабочих процессов.

Использование:

php webman status

Опции:

connections

Получение информации о подключениях рабочих процессов.

Использование:

php webman connections