create-cli

⌨️ 人机友好的 CLI 设计规范引擎

🥥16总安装量 5评分人数 5
100% 的用户推荐

基于 clig.dev 权威指南的 CLI 设计规范技能,帮助开发者构建人机友好、脚本兼容的命令行工具。

A

基本安全,请在特定环境下使用

  • 来自可信组织或认证账号,需要结合权限范围判断
  • ✅ 纯文档型技能,无任何代码执行、文件操作或网络请求
  • ✅ 不访问环境变量、敏感数据或系统权限
  • ✅ 无动态代码执行(eval/exec)风险
  • ⚠️ 标准文档模板存在极低提示词注入风险,但内容可控
  • ✅ 来源公开透明(GitHub 社区仓库),可追溯验证

使用说明

核心用法

create-cli 是一个纯文档型指导技能,专注于命令行界面(CLI)的前期设计阶段。当用户需要从零设计 CLI 规范或重构现有 CLI 时,该技能提供系统化的设计框架。核心流程包括:首先读取内置的 CLI 设计指南(基于 clig.dev 社区标准),然后通过最小化提问快速锁定需求(命令名称、目标用户、输入输出约定、交互模式、配置层级等),最终输出可直接落地的 CLI 规范文档。

显著优点

1. 权威背书:直接引用 clig.dev 这一业界公认的 CLI 设计指南,确保设计决策符合社区最佳实践。
2. 语言无关:不绑定特定编程语言或解析库,输出的规范可被任何技术栈实现。

3. 交付物完整:提供命令树、参数表、退出码映射、安全规则、配置优先级、Shell 补全方案等全套设计资产。

4. 人性化优先:内置 TTY 检测、NO_COLOR 支持、Ctrl-C 处理等细节,平衡人类可读与机器可解析。

5. 安全内建:默认要求破坏性操作需确认,提供 --dry-run、--force、--no-input 等安全开关的设计模板。

潜在缺点与局限性

  • 非实现工具:仅输出设计规范,不生成可执行代码,开发者仍需手动实现。
  • 模板化约束:对于高度定制化的 CLI(如交互式 TUI、复杂状态机),标准模板可能需要扩展。
  • 无自动化验证:不检查设计规范与实际实现的一致性,需团队自行维护。
  • 社区标准局限:clig.dev 偏向 Unix 传统,对 Windows-native 或企业级 GUI 化 CLI 的覆盖有限。

适合的目标群体

  • 后端/工具开发者:需要为内部平台或开源项目设计 CLI 工具。
  • DevOps 工程师:构建自动化脚本友好的命令行工具。
  • 技术产品经理:评审团队 CLI 设计的一致性和可用性。
  • 开源维护者:统一多命令工具的交互体验。

使用风险

  • 设计-实现鸿沟:规范文档可能被误读或执行偏差,建议配合代码审查。
  • 过度设计:新手可能套用全部模板导致 CLI 过于复杂,需根据实际场景裁剪。
  • 版本漂移:clig.dev 指南会演进,内置引用文档可能滞后于上游。

create-cli 内容

references文件夹
手动下载zip · 6.4 kB
cli-guidelines.mdtext/markdown
请选择文件