SuperAPI AI 工具集

openspec-config

通用与其它

查看项目

更新于 10-16 03:15

技能介绍

用途:管理 OpenSpec 的配置,分项目级(openspec/config.yaml)和全局 CLI 级(openspec config 子命令)两层。项目配置用于添加项目专属上下文与规则,全局配置用于用户级设置。

适用场景:需要给项目补充上下文以提升 AI 制品质量;为单个制品设置规则(如规格必须用 Given/When/Then);修改项目默认 Schema;管理全局 CLI 设置(遥测、编辑器等)。

前置条件:项目已初始化 OpenSpec(参见 openspec-initial)。

项目配置 openspec/config.yaml 主要字段:schema(新变更的默认 Schema,如 spec-driven);context(注入所有制品指令的项目上下文,上限 50KB);rules(按制品 ID 设置规则的对象)。制品 ID 包括 proposal、specs、design、tasks。

工作机制:Schema 优先级从高到低为 CLI 标志、变更元数据、项目配置、默认值(spec-driven)。context 会以 <project-context> 标签前置到每个制品指令;rules 仅对匹配制品生效,以 <project-rules> 标签放在 context 之后。

全局 CLI 命令:openspec config list、openspec config get <key>、openspec config set <key> <value>、openspec config unset <key>、openspec config reset --all --yes、openspec config edit、openspec config path。常见设置示例:openspec config set telemetry.enabled false、openspec config set user.name "My Name" --string。

输出:生成含项目上下文与规则的 openspec/config.yaml,并通过上下文注入改善 AI 制品质量。后续可结合 openspec-new 或 openspec-explore 使用,或用 openspec-schema 创建自定义 Schema 并设为默认。

限制与排障:rules 中出现未知制品 ID 时,需确认 ID 与所用 Schema 匹配,可运行 openspec schemas --json 查看;配置未生效时确认文件位于 openspec/config.yaml(非 .yml)且 YAML 语法正确;context 上限 50KB,超出需精简或链接外部文档。