SuperAPI AI 工具集

openspec-schema

编程与开发

查看项目

更新于 10-16 10:21

技能介绍

用途:使用 openspec schema 子命令创建和管理自定义工作流 schema。schema 定义存在哪些产物(artifact)及其依赖关系;默认的 spec-driven schema 提供 proposal -> specs -> design -> tasks,自定义 schema 可支持不同工作流。

适用场景:需要自定义工作流(如 research-first、快速迭代);用户提出创建 schema、自定义工作流、派生 spec-driven schema;调试 schema 解析;校验自定义 schema 结构。

前置条件:已安装 OpenSpec CLI(见 openspec-install)。

主要用法: 从零创建:openspec schema init my-workflow(交互式,提示描述、产物、默认值);非交互式:openspec schema init rapid --description "Rapid iteration" --artifacts "proposal,tasks" --default。会在 openspec/schemas/my-workflow/ 下生成 schema.yaml 与 templates/。 派生已有 schema:openspec schema fork spec-driven my-workflow。 校验:openspec schema validate my-workflow,或省略名称校验全部。 查看解析来源:openspec schema which spec-driven;openspec schema which --all,显示来自 package、project 或 user。

结构:openspec/schemas/<name>/ 含 schema.yaml(产物定义与依赖)与 templates/(各产物模板,如 proposal.md 等)。schema.yaml 中用 artifacts 列表定义 id、generates、requires 字段表达产物与依赖。

优先级:项目 openspec/schemas/<name>/(本地、纳入版本控制)> 用户 ~/.local/share/openspec/schemas/<name>/(全局)> 包内置 schema(如 spec-driven)。

后续:用 openspec-new 配合 /opsx:new my-change --schema my-workflow 使用该 schema,或在 openspec-config(openspec/config.yaml)中设为默认。

限制与排错:提示“Schema not found”时用 openspec schemas 查看可用 schema,并用 openspec schema which <name> 检查解析;校验错误可用 openspec schema validate <name> --verbose 查看详情;规则中出现未知产物 ID 时用 openspec schemas --json 查看各 schema 的产物 ID。其他功能与费用等资料暂未提供。