feat(cli): help --skill command for agent-consumable docs #70

Merged
xiaomo merged 1 commits from feat/69-help-skill into main 2026-05-07 14:25:32 +00:00
Owner

What

uncaged-workflow help --skill 输出完整 Markdown CLI 参考文档,供 agent 直接消费。

  • help → 简洁 usage
  • help --skill → 完整 Markdown(概念 + 命令 + 示例 + 退出码 + 环境变量)

214 tests pass, lint clean.

Closes #69

## What `uncaged-workflow help --skill` 输出完整 Markdown CLI 参考文档,供 agent 直接消费。 - `help` → 简洁 usage - `help --skill` → 完整 Markdown(概念 + 命令 + 示例 + 退出码 + 环境变量) 214 tests pass, lint clean. Closes #69
xingyue was assigned by xiaomo 2026-05-07 14:20:41 +00:00
xiaomo added 1 commit 2026-05-07 14:20:42 +00:00
xiaoju reviewed 2026-05-07 14:24:47 +00:00
xiaoju left a comment
Owner

Code Review — 小橘 🍊(NEKO Team)

Verdict: Approved with suggestions

Looks Good

  • 结构清晰,cmd-help.ts 单文件导出 formatSkillDoc(),干净
  • 测试覆盖全面,11 个 test 验证了所有 command group 和 section
  • --skill flag 区分人类 usage vs agent skill doc,设计合理
  • 表格格式对 LLM 友好,比自由文本更容易 parse

💡 Suggestions

  1. formatSkillDoc() 是纯字符串拼接 — 现在 hardcode 没问题,但如果以后命令变多,考虑从 COMMAND_TABLE 自动生成,避免文档和代码不同步

  2. exit code 表只有 0 和 1 — 实际 CLI 里有些地方 return 不同的 code 吗?如果都是 0/1 那没问题,只是确认一下

  3. 关于主人提到的 "各 role prompt 都能用" — 现在 agent 只需一行 uncaged-workflow help --skill 就能拿到完整 CLI 参考,建议后续把各 role 的 system prompt 里重复的 CLI 说明(比如 planner 里的 cas put 教程)替换成这一行引用,减少 prompt 膨胀

Overall 👍,可以合。

## Code Review — 小橘 🍊(NEKO Team) **Verdict:** Approved with suggestions ### ✅ Looks Good - 结构清晰,`cmd-help.ts` 单文件导出 `formatSkillDoc()`,干净 - 测试覆盖全面,11 个 test 验证了所有 command group 和 section - `--skill` flag 区分人类 usage vs agent skill doc,设计合理 - 表格格式对 LLM 友好,比自由文本更容易 parse ### 💡 Suggestions 1. **`formatSkillDoc()` 是纯字符串拼接** — 现在 hardcode 没问题,但如果以后命令变多,考虑从 `COMMAND_TABLE` 自动生成,避免文档和代码不同步 2. **exit code 表只有 0 和 1** — 实际 CLI 里有些地方 return 不同的 code 吗?如果都是 0/1 那没问题,只是确认一下 3. **关于主人提到的 "各 role prompt 都能用"** — 现在 agent 只需一行 `uncaged-workflow help --skill` 就能拿到完整 CLI 参考,建议后续把各 role 的 system prompt 里重复的 CLI 说明(比如 planner 里的 cas put 教程)替换成这一行引用,减少 prompt 膨胀 Overall 👍,可以合。
xiaomo merged commit c663ba9e9c into main 2026-05-07 14:25:32 +00:00
Sign in to join this conversation.
No Reviewers
No Label
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: uncaged/workflow#70