Aura.Cli 项目技术文档

1. 安装指南

环境要求

• PHP 7.2 或更高版本。建议使用最新版本的 PHP。

安装方式

使用 Composer 安装

1. 打开终端或命令行工具。
2. 运行以下命令安装 Aura.Cli：

   composer require aura/cli
   

手动安装

1. 从 GitHub 发布页面 下载最新版本的压缩包。
2. 解压压缩包到你的项目目录。
3. 在项目中引入 autoload.php 文件：

   require 'path/to/Aura.Cli/autoload.php';
   

2. 项目使用说明

上下文对象 (Context)

Context 对象提供了命令行环境的信息，包括通过命令行传递的选项标志。你可以通过 CliFactory 创建 Context 对象：

<?php
use Aura\Cli\CliFactory;

$cli_factory = new CliFactory;
$context = $cli_factory->newContext($GLOBALS);
?>

你可以通过 $env、$server 和 $argv 属性对象访问 $_ENV、$_SERVER 和 $argv 的值。

获取选项和参数

Context 对象支持从命令行 $argv 值中解析选项和参数。使用 getopt() 方法获取选项和参数：

<?php
$options = [
    'a',        // 短标志 -a，不允许参数
    'b:',       // 短标志 -b，需要参数
    'c::',      // 短标志 -c，参数可选
    'foo',      // 长选项 --foo，不允许参数
    'bar:',     // 长选项 --bar，需要参数
    'baz::',    // 长选项 --baz，参数可选
    'g*::',     // 短标志 -g，参数可选，可多次传递
];

$getopt = $context->getopt($options);
?>

标准输入/输出流 (Stdio)

Stdio 对象允许你处理标准输入/输出流。通过 CliFactory 创建 Stdio 对象：

<?php
use Aura\Cli\CliFactory;

$cli_factory = new CliFactory;
$stdio = $cli_factory->newStdio();
?>

你可以使用 outln() 和 errln() 方法分别向标准输出和标准错误输出打印信息。

3. 项目 API 使用文档

Context 对象 API

• newContext($GLOBALS): 创建一个新的 Context 对象。
• getopt($options): 解析命令行选项和参数。
• env->get($key, $default): 获取 $_ENV 中的值。
• server->get($key, $default): 获取 $_SERVER 中的值。
• argv->get($key, $default): 获取 $argv 中的值。

Stdio 对象 API

• newStdio(): 创建一个新的 Stdio 对象。
• outln($message): 向标准输出打印一行信息。
• errln($message): 向标准错误输出打印一行信息。
• inln(): 从标准输入读取一行。

GetoptValues 对象 API

• get($option, $default): 获取选项的值。
• hasErrors(): 检查是否有解析错误。
• getErrors(): 获取解析错误。

4. 项目安装方式

使用 Composer 安装

composer require aura/cli

手动安装

1. 下载项目压缩包。
2. 解压并引入 autoload.php 文件。

通过以上步骤，你可以轻松安装和使用 Aura.Cli 项目，并利用其提供的命令行工具功能。