切换主题
yoyoboot admin doctor
调用失败或准备使用 Admin CLI 时,检查 Node、pnpm、仓库布局、必需包和生成 catalog。命令只诊断当前状态,不安装依赖或自动修复。
基本用法
text
yoyoboot admin doctor [--repo <path>] [--json]在 YoyoBoot 源码仓库中运行
检查当前 Admin 环境,诊断不会修复文件。
text
pnpm --dir tools/yoyoboot-cli run cli -- admin doctor --json参数
| 参数 | 必填 | 说明 |
|---|---|---|
--json | 否 | 以 JSON 输出完整结果信封,供机器读取。 |
--help | 否 | 展示帮助;yoyoboot --help / yoyoboot <command> --help。 |
--repo <path> | 否 | 显式指定仓库查找起点;缺省从当前工作目录向上查找。 |
示例
固定示例仓库中的返回结果
text
yoyoboot admin doctor --json此命令针对固定示例仓库。下面只展示公开字段投影,不是当前 checkout 的完整输出。
json
{
"command": "doctor",
"status": "ok",
"data": {
"node": "<node-version>",
"platform": "<platform>"
}
}返回结果
环境检查诊断与本机运行信息。
主要字段
| 字段 | 说明 |
|---|---|
command | 实际结果命令名;Admin 保留子命令名,入口捕获异常时为 cli。 |
status | ok / warn / error;同时检查退出码及诊断码。warn 可以退出 0。 |
findings[] | 诊断项包含 code、status、message,可选 detail;机器使用 code 分支,不解析消息。 |
source | JSON 顶层命令实现来源,包含 kind / path / owner。 |
data | 命令结果;入口捕获失败时可能缺省,部分诊断失败仍保留结果。 |
data.node | 实际 Node 版本;最低 Node 主版本 20。 |
data.platform | process.platform/process.arch。 |
data.startDirectory | 本机查找起点;无法定位仓库时 data 缺省。 |
data.repoRoot | 本机仓库根绝对路径。 |
data.workspace | 本机 Admin workspace 绝对路径。 |
findings[].code | node-version、package-manager、repo-root、workspace-layout、package-manifest、crud-catalog、capability-catalog,或仓库定位失败码。 |
使用说明
- 仓库根使用
pnpm --dir tools/yoyoboot-cli run cli -- <命令参数>;已完成构建时也可使用node tools/yoyoboot-cli/dist/bin.js <命令参数>。 - JSON 示例来自固定示例仓库的公开投影,省略实现来源、规则文件位置及大段内容;
<...>是明确的环境占位符。完整字段见返回结果表,实际内容以当前工作树为准。 - 全局参数严格解析:未知、重复、缺值参数返回退出码 2;
--help输出文本,即使同时指定--json。 - 此结果没有独立的
data.schemaVersion;不要把来源 catalog 版本或 Reference metadata 版本当成结果版本。 - 实际调用 pnpm --version 检测可用性;不安装依赖、不修复文件。Node/pnpm/layout 错误导致退出 2;catalog 缺失或 JSON 不可解析可仅为 warn、退出 0。
- catalog 检查只证明存在且 JSON 可解析,不证明所有领域字段完整。创建与 inspect 仍执行各自正式合同校验。
退出码
| Exit code | 含义 |
|---|---|
0 | 成功或仅有警告;警告仍需阅读。 |
2 | 预期失败:参数、仓库或领域条件不满足,或严格检查未通过。 |
1 | 未预期程序错误。 |
常见错误
package-manager
pnpm 不可执行或与仓库版本 11.28.0 不符。
处理方式:准备仓库要求的 pnpm,再重试。
workspace-layout
Admin workspace、宿主 app 或组合入口缺失。
处理方式:核对当前 checkout 布局。
package-manifest
必需包 manifest 缺失或不可解析。
处理方式:修复正式包 manifest。
相关命令
Reference 合同版本:
1.0.0结果合同版本:未独立版本化(实际结果没有 data.schemaVersion)
源码产品版本:
10.5.7(不代表 registry 发布状态)。