README

它就像 meow，但用于PHP。

安装

$ composer require troublete/cli

用法

一些脚本内容，假设 cli.php。

<?php
require_once 'path/to/vendor/autoload.php';

use function Cli\cli;

$app = cli($argv, 'Usage: <flags>');

if ($app->flags->someFlag !== false) {
	$app->print($app->flags->someFlag);
	exit;
}

通过以下参数调用脚本，它将输出 🌈。

$ php cli.php --someFlag 🌈

示例请参见 /examples。

API

函数

`cli($arguments, $helpMessage, $flagAliases = [], $showHelp = true, $outputStreams = [])`

一个函数，用于实例化一个匿名类实例，并将相关信息作为公共属性。因此，它们是公开的，可以直接使用。

参数

参数	类型	描述
$arguments	`数组`	脚本应从中获取标志和值的参数（在大多数情况下应该是 `$argv`）。
$helpMessage	`字符串`	当脚本调用时显示的帮助/欢迎消息（在调用 `--help` 或未提供任何参数时显示，有关 `$showHelp` 的更多信息）。
$flagAliases	`数组`	一个包含标志短别名的数组。例如，`['h' => 'help']` 允许使用 `-h` 而不是 `--help`。
$showHelp	`布尔值`	标志，用于确定在无参数调用时是否应显示帮助消息。
$outputStreams	`数组`	一个数组，包含 `print()` 方法在调用时要写入的输出流。（默认为 `STDOUT`）

属性

属性	类型	描述
composer	`\stdClass`	包含composer包信息，如果可用则从 `getcwd()` 读取。
flags	`class@anonymous`	包含带有简单API的标志（有关更多信息，请参阅相关包argv）。
isCommand	`布尔值`	包含有关当前调用是否为命令调用的信息。
commandName	`字符串`	包含当前命令名称，如果是命令调用，则为空。
helpMessage	`字符串`	包含为CLI定义的帮助消息。

方法

方法	描述
`print(string $contents)`	一个方法，用于在设置的输出流中打印某些内容（只是为了有一个共同的做这件事的方式，请参阅 `$outputStreams`）

troublete / cli

维护者

详细信息

README

安装

用法

API

函数

`cli($arguments, $helpMessage, $flagAliases = [], $showHelp = true, $outputStreams = [])`

参数

属性

方法

相关包

许可证