From cli-help-layers
CLI Help Layers 帮助信息分层设计指南。在设计或编写 CLI 工具的帮助文档(usage、help、man)时使用。 适用于需要让 AI Agent 高效解析和调用 CLI 命令的场景:命令结构设计、参数命名、渐进式披露、示例覆盖策略、错误信息设计等。 触发词:CLI 文档设计、帮助信息设计、CLI help layers、agent 友好 CLI、命令行规范、usage/help/man 设计。
How this skill is triggered — by the user, by Claude, or both
Slash command
/cli-help-layers:cli-help-layersThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
为 AI-First CLI 的命令行交互与文档体系提供设计指引。核心读者:人类开发者 + LLM/Agent。
为 AI-First CLI 的命令行交互与文档体系提供设计指引。核心读者:人类开发者 + LLM/Agent。
| 触发方式 | 层级 | 覆盖率 | 内容 |
|---|---|---|---|
| 命令不带参数 | @USAGE | 80% | BRIEF + SYNTAX + 3-5 EXAMPLES |
-h / --help | @HELP | 95% | OPTIONS 表 + ENUMS + COMMON ERRORS |
子命令 --help | @HELP sub | 98% | 特有选项 + INHERITED OPTIONS + TEMPLATE |
--man | @MAN | 100% | SCHEMA + EXIT CODES + ALL ERRORS + CAVEATS |
@USAGE <path> / @HELP <path> / @MAN <path> → 层级标识
BRIEF: / SYNTAX: / OPTIONS: / ENUMS: / EXAMPLES: / ERRORS: → 区块标签
# [RECOMMENDED] / [TEMPLATE] / [PIPELINE] / [ADVANCED] → 示例标签
Agent 定位正则:^@(USAGE|HELP|MAN)\s+(.+)$,区块:^([A-Z ]+):$
每层输出的最后一行必须包含指向下一层的提示,形成引导链:
| 当前层 | 尾部提示文案 |
|---|---|
@USAGE (无参数输出) | Run '<cmd> --help' for all options and error codes. |
@HELP (-h/--help 输出) | Run '<cmd> --man' for full schema, exit codes, and caveats. |
@MAN (--man 输出) | 无(已是最完整层) |
设计要点:
\033[2m)或尾注格式,避免干扰主要内容--man,可替换为 See docs at <url> 或 man <cmd>设计或审查 CLI 帮助文档时:
references/architecture.md(命名规则、名词-动词组织)references/usage-spec.md(模板 + 示例挑选原则)references/help-spec.md(OPTIONS 表 + 枚举 + Sub-command Help)references/man-spec.md(SCHEMA + EXIT CODES + 完整错误码)references/error-design.md(错误码编码 + 各层嵌入策略)references/agent-friendly.md(文案风格 + 标记系统 + 披露流程)references/checklist.md(五维度 checklist)references/example-feishu-doc.md(feishu doc 命令族三层完整实践)references/faq.md(设计理念来源、标记选择等)Do not use this skill for:
Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Applies a firm's KYC/AML rules grid to parsed onboarding records: assigns risk rating, checks required documents, outputs rule outcomes with citations, and routes for escalation.
Generates daily or weekly digests of activity from connected sources (chat, email, docs, tasks, CRM), highlighting action items, decisions, mentions, and project updates.
npx claudepluginhub luw2007/skills --plugin cli-help-layers