SuperAPI AI 工具集

system-type-cli-tool

通用与其它

查看项目

更新于 10-16 06:47

技能介绍

该资源是微软 amplifier-bundle-systems-design 中针对命令行工具(CLI)与开发者 SDK 的系统类型模式集,整理此类工具在设计实现中的常用模式、失败模式与反模式。

用途与结构:围绕 CLI 工程实践展开,适合设计、评审或重构命令行工具与开发者库时参考。

主要内容: 命令结构:子命令树(如 git 风格,建议嵌套不超过两层)、POSIX 短标志与 GNU 长标志、布尔与取值标志、-- 分隔符、位置参数与标志的取舍、全局与本地标志、交互式提示与 TTY 检测。 输入输出纪律:stdout 只输出可解析数据,stderr 输出人类提示与错误,stdin 支持以 - 表示输入及管道。 配置分层:命令行标志 > 环境变量 > 项目配置 > 用户配置 > 系统配置 > 编译默认值;遵循 XDG 目录规范;比较 TOML、YAML、JSON、INI 格式;配置发现与合并、显式 --config、config show 调试。 插件架构:PATH、目录、注册表三种发现方式;插件 API 稳定性、能力协商;钩子点与完整扩展的取舍。 分发与安装:语言原生与系统包管理器、单二进制分发、交叉编译、自动更新(需选择加入、限频、支持固定版本)、跨平台路径与换行处理。 向后兼容:输出即 API,提供 --output json,遵循语义化版本;标志弃用分阶段策略;区分 UI 变更与 API 变更。 Shell 集成:自动补全生成与安装、退出码约定(0 成功、1 通用错误、2 用法错误,不超过 125)、SIGINT/SIGTERM/SIGPIPE 信号处理与临时文件清理、TTY 检测与颜色(NO_COLOR、FORCE_COLOR)。 错误处理:渐进式披露(默认简短、--verbose、--debug)、可操作的错误信息。

限制:该资料为设计模式说明,未提供具体安装命令、代码实现、许可证、平台支持清单或收费信息,具体用法需结合对应工具的项目资料。