SuperAPI AI 工具集

openspec

编程与开发

查看项目

更新于 10-15 16:34

技能介绍

概述

OpenSpec(OPSX)Skill 用于指导或推理 OpenSpec 产物驱动的工作流系统(OPSX),涵盖产物图、schema/模板解析、变更生命周期以及实验性命令与技能。

核心概念

  • 产物图,而非工作流引擎:依赖关系用于启用操作,而不强制线性阶段。
  • 文件系统即数据库:完成度由文件是否存在推导,而非存储的状态。
  • 确定性 CLI:命令需要显式的变更上下文(智能体负责推断,CLI 保持严格)。
  • XDG schema 解析:用户覆盖优先于内置项。
  • 模板以 schema 为作用域:模板与 schema 相邻,并采用严格的 2 级回退解析。

快速导航

  • 产物图核心概念:references/artifact-core.md
  • OPSX 工作流行为与用法:references/opsx-workflow.md
  • 安装与配置档(init、update、config profile):references/setup-profiles.md
  • schema 定制工作流与缺口:references/schema-customization.md
  • 端到端 schema 工作流缺口与拟议方案:references/schema-workflow-gaps.md
  • 实验性发布计划与发布清单:references/experimental-release-plan.md

OPSX 命令

命令 用途
/opsx:explore 思考想法、调查问题(无结构)
/opsx:new 开始一个新变更
/opsx:continue 根据依赖创建下一个产物
/opsx:ff 快进——一次性创建所有规划产物
/opsx:apply 实现任务,按需更新产物
/opsx:verify 校验实现是否符合规范
/opsx:sync 将 delta 规范同步到主规范
/opsx:archive 归档单个已完成的变更
/opsx:bulk-archive 一次性归档多个已完成的变更

旧版(非 OPSX)命令:/openspec:proposal 一次性创建所有规划产物。优先使用 OPSX,但对小型/简单变更或较旧配置可能有用。

Schema 管理

openspec schemas                    # 列出可用 schema
openspec schema which --all         # 显示解析来源
openspec schema init my-workflow    # 交互式创建新 schema
openspec schema fork spec-driven my-workflow  # 复刻现有 schema
openspec schema validate my-workflow  # 校验 schema 结构

项目配置

创建 openspec/config.yaml 进行按项目的设置:

schema: spec-driven

context: |
  Tech stack: TypeScript, React, Node.js
  Testing: Vitest, Playwright

rules:
  proposal:
    - Include rollback plan
  specs:
    - Use Given/When/Then format

Schema 优先级:CLI 标志 → 变更元数据 → 项目配置 → 默认(spec-driven)

决策规则

  • 当意图保持不变、且是在细化范围或方法时,优先更新。
  • 当意图或范围发生根本性改变,或原始内容可独立完成时,优先新建变更。
  • 始终保留产物(proposal/specs/design/tasks)为何变更的清晰历史。

配方(Recipes)

  1. 显示下一步可创建的产物:确定活动变更 id;在显式设置变更的情况下查询状态与就绪产物;呈现就绪产物及其依赖。预期行为:显示就绪产物,而非必需步骤。
  2. 为特定产物生成说明:通过 XDG 回退解析 schema 与模板;构建上下文(变更元数据、依赖状态、目标路径);以纯 Markdown 返回丰富后的说明。
  3. 开始一个新变更:校验变更名(kebab-case);创建变更目录与 README;显示初始状态与第一个就绪产物。
  4. Schema 定制指导:说明 XDG 覆盖路径;描述复制内置 schema 与模板;提供校验步骤或推荐的 CLI 命令以列出与解析。
  5. 解释变更的 schema 绑定:优先使用可用的变更元数据;若配置了项目默认 schema 则回退到它;否则默认 spec-driven。

禁止事项

  • 不要将系统视为线性工作流引擎。
  • 不要在未显式选择的情况下假定某变更处于活动状态。
  • 不要在 schema 或模板之间静默回退而不报告。
  • 不要逐字复制冗长的厂商文档;应总结并提供可操作的指导。

输出预期

  • 给出清晰的产物就绪状态与依赖说明。
  • 在示例中使用显式的变更标识符。
  • 提供简洁、可操作的步骤,并说明它们是信息性的还是必需的。

发布亮点(1.2.0 → 1.3.0)

  • 更多工具集成:新增对 Junie、Lingma、ForgeCode 和 IBM Bob 的支持。
  • 更安全的安装:shell 补全安装现为可选(opt-in),Copilot 自动检测不再仅凭裸 .github/ 目录触发。
  • 适配器修复:修正了 Pi 命令生成,OpenCode 现使用规范的 .opencode/commands/ 路径。
  • 更安全的状态检查:当项目尚无变更时,openspec status 现在会干净退出。

适用场景

该 Skill 适用于希望采用规范驱动、产物化方式规划、实现、校验与归档变更的开发工作流,并需要了解或操作 OPSX 命令、schema 定制及项目配置的场景。

限制

资料的官方文档正文为空;除上述内容外,暂无更多关于功能、收费、价格、平台或效果的细节。