SuperAPI AI 工具集

verifiable-surfaces

编程与开发

查看项目

更新于 10-15 20:33

技能介绍

用途:在编写或修改 CLI、工具、库、服务及配置时,确保新增或改动的“表面”可被低成本、无害地实际演练。核心不变量是:无法廉价且无害演练的表面,等于未真正验证;语法、类型和 lint 检查必要但不充分。

主要能力:分两种模式。编写模式要求新增表面满足七项清单:--help 必带并列出用法、每个标志、示例与退出码;任何副作用都要有 --dry-run,且仍加载真实配置并解析真实计划;配置加载程序提供 --print-config/--show-config 输出合并后配置;提供隔离状态冒烟入口,支持 --config <path> 并尊重 $HOME/XDG_CONFIG_HOME;明确退出码约定(0 成功,非零表示失败类);stdout 输出数据,stderr 输出诊断;完成后自验证。验证模式给出验证阶梯:语法/模式门、渲染/应用配置门、应用原生加载器门、编译/构建门、无害运行时冒烟,逐级取最高安全级,不可跳过无害的更高一级。

使用方式:先判断适用模式,两者常同时存在。编写时走七点清单;验证时列出本次改动的最小阶梯,从最低成本门开始,直到最高无害门通过;某门失败则修复后重跑受影响的前序门;最后汇总实际执行的命令与通过的最高门。Ansible 特别规则:--syntax-check 仅是第一步,若变更可能在执行时失败,应运行最窄相关冒烟,如 --check、--diff、--tags、--limit 或本地/容器清单。具体模板与各生态命令见 references/authoring-checklist.md 与 references/config-examples.md。

适用场景:Python 新 CLI(uv + tyro/click/typer/argparse)、Node CLI(commander/yargs/oclif)、带参数或副作用的 Bash 脚本、新增子命令/标志/环境变量、带配置的服务守护进程、加载配置的 SDK/库;以及编辑 next.config.*、pyproject.toml、docker-compose.yml、chezmoi 模板、Ansible/Terraform/Kubernetes/CI 等配置与自动化,或调试“lint/build 通过但启动失败”的问题。

限制:纯文档编辑、且无行为变化的格式化-only 编辑,或需要用户未批准的凭据与实盘基础设施的生产部署验证,均不适用;后者应停在无害本地冒烟并报告未覆盖的缺口。仅语法验证安全时,应明确说明“语法通过;加载器/运行时未演练”,并给出应在合适环境执行的命令,而非给出虚假信心。