Skip to content

overview

Inhere edited this page Jan 10, 2019 · 1 revision

php 命令行应用库

License Php Version Latest Stable Version

简洁、功能全面的php命令行应用库。提供控制台参数解析, 命令运行,颜色风格输出, 用户信息交互, 特殊格式信息显示。

功能简介

  • 命令行应用, 命令行的 controller, command 解析运行
  • 支持给命令设置别名,一个命令可以有多个别名。支持命令的显示/隐藏,启用/禁用
  • 功能全面的命令行的选项参数解析(命名参数,短选项,长选项 ...)
  • 命令行的 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 兼容的,不支持颜色的环境会自动去除相关CODE
  • 使用方便简单。可以方便的整合到任何已有项目中。

内置工具

  • 内置Phar工具类,可以方便的将应用打包成 phar文件,方便作为工具分发和使用
    • 运行示例中的命令 php examples/app phar:pack,会将此console库打包成一个app.phar
  • 内置的简单的命令行文件下载工具类,支持进度条显示
  • 命令行的php代码高亮支持(来自于jakub-onderka/php-console-highlighter并做了一些优化调整)
  • Terminal::class 简单的Terminal屏幕、光标控制操作类
  • ProcessUtil::class 简单的进程操作使用类(fork,run,stop,wait ... 等)
  • 支持快速的为当前应用生成 bash/zsh 环境下的自动补全脚本

文档里显示的所有的特性,效果都是运行 examples/ 中的示例代码 php examples/app 展示出来的。基本上涵盖了所有功能,可以直接测试运行