SuperAPI AI 工具集

cli-development

编程与开发

查看项目

更新于 10-16 03:41

技能介绍

用途:为构建命令行应用、设计命令接口和选择 CLI 工具链提供模式与约定参考。

主要能力: 命令结构采用动词-名词模式,如 tool create project、tool deploy app、tool logs get、tool config set key value,层级最多两级,常用动词包括 create、delete、list、show、update、get、set。 标志约定:-h/--help 同时支持长短形式;-v/--verbose 增加输出细节;-f/--force 跳过确认;-o/--output json 指定格式;--dry-run 展示将要执行的操作。布尔标志不取值,带值标志可用空格或等号。 帮助文本包含 USAGE、DESCRIPTION、FLAGS、EXAMPLES、SEE ALSO 等部分,示例中展示 tool deploy my-app 与 tool deploy my-app --env production --force。 错误信息需说明出错原因、上下文、具体修复方式和帮助引用,例如配置文件缺失时提示运行 tool init 或用 --config 指定路径。 退出码:0 成功,1 一般错误,2 误用(无效参数),126 不可执行,127 命令未找到。 输出默认人类可读,按需机器可读,如 tool list users、--format json、-o yaml。 渐进式披露:简单命令配合理默认值,高级选项存在但不突出,帮助按经验水平组织,通过 --help 和提示发现功能。 反模式:无长形式的隐晦缩写、用户输出中出现堆栈跟踪、静默失败、常见场景要求必填标志、超过两级的深层命令层级、跨命令动词不一致。 工具链参考见 references/toolchain.md,涵盖 Commander.js(Node.js 默认)、oclif(企业级 CLI)、Ink(终端 React)、Cobra(Go CLI)、Thor(Ruby CLI)。

适用场景:设计或实现命令行工具、统一命令接口与错误处理、选择 CLI 框架时参考。

限制:资料未提供具体安装命令、版本要求、收费信息或完整代码示例,相关细节暂未提供。