Консоль PHP

Полнофункциональная библиотeka для создания приложений командной строки на PHP.

Предоставляет парсинг параметров консоли, выполнение команд, цветовое оформление вывода, взаимодействие с пользователем и отображение информации в специальном формате.

ВНИМАНИЕ: Версии v4.1+ требуют PHP 8.0+

Предварительный просмотр командной строки

Возможности> Просто в использовании. Может легко быть интегрирована в любой существующий проект. — Консольное приложение, парсинг команд controller, command выполняется в командной строке

— Поддержка установки псевдонимов для команд. Каждой команде могут соответствовать несколько псевдонимов. — Поддержка отображения/скрытия команд, включения/отключения. — Полнофункциональный парсер параметров командной строки (именованные параметры, короткие опции -s, длинные опции --long). — Управление входными данными input и выходными данными output командной строки, использование — Комментарии методов команд автоматически парсятся как справочная информация (по умолчанию используются метки @usage, @arguments, @options, @example) — Поддержка вывода текстовых сообщений с использованием различных цветовых стилей (info, comment, success, warning, danger, error. . . ) — Отображение специальных форматированных данных (section, panel, padding, helpPanel, table, tree, title, list, multiList) — Обогащённое динамическое отображение информации (pending/loading, pointing, spinner, counterTxt, dynamicText, progressTxt, progressBar) — Поддержка взаимодействия пользователя (select, multiSelect, confirm, ask/question, askPassword/askHiddenInput) — Поддержка заранее определённых параметров, аналогично symfony/console (задание значений параметров по позиции, рекомендовано при строгих ограничениях на параметры) — Цветной вывод совместим с окружением windows, linux, mac.В средах, не поддерживающих цвет, автоматически удаляются соответствующие коды.

• Быстрое генерирование скриптов автодополнения для текущего приложения в окружении bash/zsh
• НОВИНКА: Поддержка запуска интерактивной оболочки для выполнения приложения

Встроенные инструменты- Встроенный класс упаковки Phar, который позволяет легко упаковывать в файлы phar. Просто распространяйте и используйте

• Выполните команду php examples/app phar:pack, чтобы упаковать эту консольную библиотеку в файл app.phar.
• Встроенный класс для скачивания файла с прогресс-баром отображения.
• Поддержка выделения цветами PHP-кода через командную строку (из jakub-onderka/php-console-highlighter с некоторыми изменениями).
• Простой класс управления экраном терминала и курсора.
• Классы для выполнения простых операций над процессами (вилка, запуск, остановка, ожидание...).

Все возможности и эффекты могут быть проверены в примерах кода phps/app в папке examples/. Они охватывают все основные возможности и могут быть протестированы непосредственно.

Установка

• Требования: PHP 8.0+

composer require inhere/console

Список документов

Для подробной документации использования обратитесь к WIKI.- Главная страница документации

• Обзор возможностей

• Установка

• Создание приложения

• Добавление команды

• Добавление группы команд

• Регистрация команды

• Получение ошибок/исключений

• Объект входных данных

• Объект вывода

• Форматированный вывод

• Динамический вывод прогресса

• Интерактивное взаимодействие пользователя

• Расширенные инструменты## Адрес проекта

• GitHub https://github.com/inhere/php-console.git

• Gitee https://gitee.com/inhere/php-console.git

Единичные тесты

phpunit
// вывод покрытия без xdebug
phpdbg -dauto_globals_jit=Off -qrr /usr/local/bin/phpunit --coverage-text

Отладка

Уровень отладки можно установить с помощью переменной окружения CONSOLE_DEBUG=уровень или глобального параметра --debug уровень.

# через переменные окружения
$ CONSOLE_DEBUG=4 php examples/app
$ CONSOLE_DEBUG=5 php examples/app
# через глобальные параметры
$ php examples/app --debug 4

Пример использования проектами

Просмотрите эти проекты, которые используют https://github.com/inhere/php-console:

• Kite Kite — это инструмент для помощи в разработке.
• Больше примеров, пожалуйста, посмотрите используются на GitHub

Лицензия

MIT

Мои проекты

• inhere/php-validate Компактная и полностью функциональная библиотека проверки данных на PHP
• inhere/sroute Легковесная и быстрая библиотека маршрутизации HTTP запросов