mcpField
O
openspec-config

openspec-config

github.com/full-stack-skillsAgent 工作流188 次安装4 周前更新
代码仓库

关于 openspec-config

openspec-config 是用于管理 OpenSpec 项目配置和全局 CLI 设置的 Agent 技能。它可配置项目上下文、制品规则、默认 schema，以及遥测和编辑器等用户级选项。

主要功能

  1. 01设置项目上下文与规则
  2. 02选择项目默认 schema
  3. 03管理全局 CLI 设置
  4. 04将上下文注入制品说明

适用场景

  1. 01为 AI 生成的制品补充项目背景
  2. 02为不同制品设定格式规则
  3. 03更改默认 schema 或 CLI 选项

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/full-stack-skills/openspec-skills --skill openspec-config

安装后在 Claude Code 中输入/openspec-config确认已加载。

附带文件agents/openai.yaml

详细介绍

OpenSpec 配置技能

在两个层级管理 OpenSpec 配置：用于项目特定上下文和规则的项目配置（openspec/config.yaml），以及用于用户级设置的全局 CLI 配置（openspec config 子命令）。

使用时机

  • 用户希望添加项目上下文，以提升 AI 工件的质量。
  • 设置针对不同工件的规则（例如，“规格必须使用 Given/When/Then”）。
  • 更改项目的默认架构。
  • 管理全局 CLI 设置（遥测、编辑器等）。

前提条件

  • 项目中已初始化 OpenSpec（参见 openspec-initial）。

项目配置

openspec/config.yaml
# Default schema for new changes
schema: spec-driven

# Project context injected into all artifact instructions
context: |
  Tech stack: TypeScript, React, Node.js
  API conventions: RESTful, JSON responses
  Testing: Vitest for unit tests, Playwright for e2e
  Style: ESLint with Prettier, strict TypeScript

# Per-artifact rules
rules:
  proposal:
    - Include rollback plan
    - Identify affected teams
  specs:
    - Use Given/When/Then format for scenarios
  design:
    - Include sequence diagrams for complex flows
配置字段
字段类型说明
schema字符串新建变更的默认架构（例如 spec-driven）
context字符串注入所有工件说明的项目上下文（最大 50KB）
rules对象针对不同工件的规则，按工件 ID 索引
工作原理
  • 架构优先级（从高到低）：CLI 标志 -> 变更元数据 -> 项目配置 -> 默认值（spec-driven）。
  • 上下文注入：以 <project-context> 标签包裹，并置于每个工件说明的开头。
  • 规则注入：仅针对匹配的工件，以 <project-rules> 标签包裹，并置于上下文之后。
工件 ID（spec-driven 架构）
  • proposal — 变更提案
  • specs — 规格
  • design — 技术设计
  • tasks — 实施任务

全局 CLI 配置

openspec config list          # Show all settings
openspec config get <key>     # Get a value
openspec config set <key> <value>  # Set a value
openspec config unset <key>   # Remove a key
openspec config reset --all --yes  # Reset to defaults
openspec config edit          # Open in $EDITOR
openspec config path          # Show config file location
常用设置
设置示例
禁用遥测openspec config set telemetry.enabled false
设置用户名openspec config set user.name "My Name" --string

输出

  • 包含项目上下文和规则的 openspec/config.yaml。
  • 通过上下文注入提升 AI 工件质量。

后续步骤

  • 开始使用 openspec-new 或 openspec-explore。
  • 使用 openspec-schema 创建自定义架构，并在配置中将其设为默认架构。

故障排除

  • “规则中存在未知工件 ID”：检查工件 ID 是否与架构一致；运行 openspec schemas --json。
  • 配置未生效：确保文件位于 openspec/config.yaml（而非 .yml）；检查 YAML 语法。
  • 上下文过大：上限为 50KB；请进行摘要或链接到外部文档。

参考资料

评论

支持 Markdown