SuperAPI AI 工具集

rayfin-cli-ux

设计与创作

查看项目

更新于 10-16 06:47

技能介绍

用途:为 @microsoft/rayfin-cli 提供统一、高质量的 CLI 体验标准。在设计、编写规格、实现或审查命令、参数、输出和错误前应加载本技能,完整参考见 references/cli-ux-guidelines.md。

主要能力:给出不可协商的宪法级规则(R1–R12),包括三种输出模式、禁止 console.log、每个错误附恢复提示、破坏性操作默认失败并需 --force、非交互场景不弹提示、--json 仅输出一个合法 JSON 对象且不混 ANSI/emoji、标准标志(--output、--json、-y/--yes、--verbose、--dry-run、--force、--env-file)、面向动作的进度文本、不记录凭据或 PII、--dry-run 不产生变更、--help 描述齐全、语义化退出码(0 成功、1 错误、2 取消)。还提供命令与标志的判定捷径、错误恢复提示与进度步骤示例、新命令实现路径、按规则 ID 的审查清单、dev 与 up 拓扑规则,以及 OpenSpec CLI 变更的预检清单和最终守卫清单。

使用方式:新命令优先采用 workflow + adapter 架构,在 common/src/workflows/<name>/ 中编排并返回类型化 Result<T>,Commander 动作仅作薄包装,经 Logger/Progress 适配器渲染并按 --output <mode> 选择输出;未迁移的旧命令使用 output-mode.ts(modeLog/emitJson/resolveOutputMode),该机制计划在第六阶段移除。实现旧命令时需创建命令文件、从 ../utils/output-mode.js 导入、添加 --json、-y/--yes、--verbose、按需添加 --dry-run/--force,并用 ProgressIndicator 包装进度。

适用场景:Rayfin CLI 命令、标志、输出与错误的设计、规格、实现和审查;CLI 相关 OpenSpec 变更的预检。

限制:本技能与架构 RFC 冲突时以 RFC 为准;--dry-run 的读取需有明确记录的契约,rayfin up 会认证并读取工作区元数据以确定目标,但先校验本地静态输入且不执行构建或部署写入;dev 与 up 的拓扑规则按资料执行。平台、价格、效果等未提供。