meticulous-cli-schema

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

meticulous schema

bash

meticulous schema [command..]

Purpose: Output the CLI command schema as JSON — designed for agent and programmatic use. Returns the structure of available commands (names, descriptions, subcommands, and options) without executing anything.

bash

meticulous schema [command..]

用途： 将CLI命令模式输出为JSON格式，专为Agent和程序化使用设计。无需执行任何操作即可返回可用命令的结构（名称、描述、子命令和选项）。

Options

选项

Option	Type	Description
`command`	positional (variadic)	Zero or more command path segments to drill into a specific command

选项	类型	描述
`command`	positional (variadic)	零个或多个命令路径段，可用于深入查看特定命令

Output Format

输出格式

Without arguments, outputs a JSON array of all top-level command objects:

json

[
  { "command": "auth", "describe": "Authentication commands", "subcommands": [...] },
  { "command": "ci",   "describe": "CI/CD commands",          "subcommands": [...] },
  ...
]

When targeting a specific leaf command (no subcommands), the full option schema is included:

json

{
  "command": "simulate",
  "describe": "Replay a recorded session",
  "options": {
    "sessionId": { "type": "string", "required": true },
    "appUrl":    { "type": "string" },
    "headless":  { "type": "boolean", "default": false },
    ...
  }
}

无参数时，输出包含所有顶级命令对象的JSON数组：

json

[
  { "command": "auth", "describe": "Authentication commands", "subcommands": [...] },
  { "command": "ci",   "describe": "CI/CD commands",          "subcommands": [...] },
  ...
]

当定位到特定的叶子命令（无子命令）时，会返回完整的选项模式：

json

{
  "command": "simulate",
  "describe": "Replay a recorded session",
  "options": {
    "sessionId": { "type": "string", "required": true },
    "appUrl":    { "type": "string" },
    "headless":  { "type": "boolean", "default": false },
    ...
  }
}

Examples

示例

bash

undefined

bash

undefined

List all top-level commands (structure only, no options)

列出所有顶级命令（仅结构，无选项）

meticulous schema

Show the full option schema for a specific command

显示特定命令的完整选项模式

meticulous schema simulate meticulous schema download replay meticulous schema ci run-with-tunnel

Show subcommands for a command group

显示命令组的子命令

meticulous schema ci meticulous schema auth

undefined

meticulous schema ci meticulous schema auth

undefined

Use in Agent Workflows

在Agent工作流中使用

The

schema

command is the recommended way for an agent to discover what commands exist and what options they accept before constructing a

meticulous

invocation:

Run
```
meticulous schema
```
to get the command tree.
Run
```
meticulous schema <command>
```
to get the full option list for the target command.
Construct the command with the required options.
Optionally add
```
--dryRun
```
to verify the constructed invocation before executing it.

schema

命令是Agent在构建

meticulous

调用指令前，发现可用命令及其支持选项的推荐方式：

运行
```
meticulous schema
```
获取命令树。
运行
```
meticulous schema <command>
```
获取目标命令的完整选项列表。
结合所需选项构建命令。
可选添加
```
--dryRun
```
参数，在执行前验证构建的调用指令是否正确。