CLI设计规范

技能简介

本技能用于设计命令行工具的完整接口规范，涵盖参数、标志、子命令结构、帮助文本、输出格式、错误处理、退出码、交互提示及配置优先级等要素。适用于从零设计CLI规格或重构现有工具以提升一致性与可发现性。

能做什么

• 定义命令树结构与使用说明（USAGE）
• 设计参数/标志表（类型、默认值、必填项、示例）
• 规划子命令语义与幂等性规则
• 制定输出契约（stdout/stderr分流、JSON/纯文本模式）
• 建立错误码映射与安全规则（–dry-run、确认机制）
• 明确配置/环境变量优先级（标志 > 环境 > 项目配置 > 用户配置 > 系统）
• 提供Shell补全方案与典型调用示例

使用说明

1. 首先阅读参考文档：agent-scripts/skills/create-cli/references/cli-guidelines.md，并应用其作为默认标准；完整指南见 https://clig.dev/
2. 快速澄清以下问题：命令名称与一句话用途、主要用户类型（人工/脚本/兼顾）、输入来源、输出契约、交互需求、配置模型、平台约束
3. 按模板输出CLI规格文档，包含命令树、参数表、I/O契约、退出码、安全规则、配置规则及5-10个调用示例

安装指令：本技能无需安装，直接通过技能系统调用即可。

输入与输出

见下方输入与输出表格。

风险提示

• 避免将敏感信息通过命令行标志传递
• 破坏性操作需强制交互确认或非交互模式下显式–force/–confirm
• 未正确处理Ctrl-C信号可能导致数据不一致
• TTY检测失败时可能错误触发交互提示

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/steipete/create-cli/SKILL.md
来源类型：GitHub仓库