切换主题
yoyoboot capabilities
需要发现 CLI 命令与参数时使用这个根级入口。仓库 capability ID 从 repo capabilities 获取,Admin 创建配方与查询对象从 admin capabilities 获取。
基本用法
text
yoyoboot capabilities [--repo <path>] [--json]在 YoyoBoot 源码仓库中运行
查看统一 CLI 当前命令与参数合同。
text
pnpm --dir tools/yoyoboot-cli run cli -- capabilities --json参数
| 参数 | 必填 | 说明 |
|---|---|---|
--json | 否 | 以 JSON 输出完整结果信封,供机器读取。 |
--help | 否 | 展示帮助;yoyoboot --help / yoyoboot <command> --help。 |
--repo <path> | 否 | 显式指定仓库查找起点;缺省从当前工作目录向上查找。 |
示例
固定示例仓库中的返回结果
text
yoyoboot capabilities --json此命令针对固定示例仓库。下面只展示公开字段投影,不是当前 checkout 的完整输出。
json
{
"command": "capabilities",
"status": "ok",
"data": {
"schemaVersion": "1.0.0",
"referenceSchemaVersion": "1.0.0",
"cli": {
"name": "yoyoboot",
"invocation": "yoyoboot <repo|admin|capabilities> [arguments] [options]"
}
}
}返回结果
统一 CLI 的实时命令目录。
主要字段
| 字段 | 说明 |
|---|---|
command | 实际结果命令名;Admin 保留子命令名,入口捕获异常时为 cli。 |
status | ok / warn / error;同时检查退出码及诊断码。warn 可以退出 0。 |
findings[] | 诊断项包含 code、status、message,可选 detail;机器使用 code 分支,不解析消息。 |
source | JSON 顶层命令实现来源,包含 kind / path / owner。 |
data | 命令结果;入口捕获失败时可能缺省,部分诊断失败仍保留结果。 |
data.schemaVersion | 根级 capabilities 结果版本:1.0.0。 |
data.cli | name 与 invocation。 |
data.referenceSchemaVersion | Reference metadata 版本,与具体命令结果版本独立。 |
data.globalOptions[] | flag、description、kind(boolean/value),可选 authoringOnly 与 valueName。 |
data.commands[] | 正式命令描述:name、summary、description、usage、authoring、arguments、options,可选 booleanFlags/capability/source/reference。 |
data.commands[].reference | 结果版本/字段、调用、公开示例、退出码、错误、后续命令与子命令说明。 |
data.admin | Admin capabilities 的完整投影:cli、commands、create.recipes、inspect.subjects。 |
data.source | 根级命令实现来源。 |
使用说明
- 仓库根使用
pnpm --dir tools/yoyoboot-cli run cli -- <命令参数>;已完成构建时也可使用node tools/yoyoboot-cli/dist/bin.js <命令参数>。 - JSON 示例来自固定示例仓库的公开投影,省略实现来源、规则文件位置及大段内容;
<...>是明确的环境占位符。完整字段见返回结果表,实际内容以当前工作树为准。 - 全局参数严格解析:未知、重复、缺值参数返回退出码 2;
--help输出文本,即使同时指定--json。 - 根级命令目录包含 capabilities 自身;每个命令 Reference 都由其 owner 维护。只输出合同,不执行作者操作。
- 不接受位置参数或 --dry-run;查询成功不证明具体仓库或 Admin 环境健康。
退出码
| Exit code | 含义 |
|---|---|
0 | 成功或仅有警告;警告仍需阅读。 |
2 | 预期失败:参数、仓库或领域条件不满足,或严格检查未通过。 |
1 | 未预期程序错误。 |
相关命令
Reference 合同版本:
1.0.0结果合同版本:
1.0.0源码产品版本:
10.5.7(不代表 registry 发布状态)。