SuperAPI AI 工具集

creating-cli-tools

通用与其它

查看项目

更新于 10-16 02:29

技能介绍

用途:该技能用于设计命令行界面(CLI)的表面区域,即语法与行为,目标是人机友好且便于脚本调用。开始时应先阅读 agent-scripts/skills/create-cli/references/cli-guidelines.md 并作为默认评判标准,上游完整指南见 https://clig.dev/。

主要能力:帮助确定命令树与 USAGE 概要、参数与标志表(类型、默认值、必填/可选、示例)、子命令语义(幂等性、状态变化)、输出规则(stdout 与 stderr、TTY 检测、--json/--plain、--quiet/--verbose)、错误与退出码映射、安全规则(--dry-run、确认、--force、--no-input)、配置与环境变量优先级(flags > env > 项目配置 > 用户配置 > 系统)以及 shell 补全方案。默认约定包括:-h/--help 始终显示帮助并忽略其他参数,--version 输出到 stdout,主数据到 stdout、诊断与错误到 stderr,提供 --json 与可能的 --plain,仅在 stdin 为 TTY 时提示,破坏性操作需交互确认或非交互下 --force,遵守 NO_COLOR、TERM=dumb 并提供 --no-color,Ctrl-C 快速退出、尽量崩溃式处理。

使用方式:需先澄清最少问题以锁定接口,包括命令名与一句话用途、主要用户(人类、脚本或两者)、输入源(参数与 stdin、文件与 URL、密钥不通过标志传递)、输出约定、交互性、配置模型、平台与运行时限制;用户不确定时可先用最佳猜测默认值推进。交付物为一份紧凑规格:命令树与 USAGE、参数/标志表、子命令语义、输出规则、错误与退出码映射、安全规则、配置/环境规则、补全说明及 5–10 个示例调用(含管道/stdin 示例)。

限制:该技能语言无关,仅在用户要求时才推荐特定语言的解析库;若请求是“设计参数”,不应偏入实现细节。资料未提供更多关于具体平台限制、版本要求或收费信息。