opencode-cabbage

Appearance

配置指南 ​

本文档详细说明 opencode-cabbage 的所有配置选项。

安装配置 ​

基础安装 ​

json
// opencode.json
{
  "plugin": ["@devcxl/opencode-cabbage"]
}

自定义覆盖 ​

插件启动后会自动注入 slash command、skills 和 agents。你可以通过 opencode.json 覆盖任何注入项：

json
{
  "plugin": ["@devcxl/opencode-cabbage"],
  "command": {
    "/my-custom-requirements": {
      "template": "自定义需求分析模板...",
      "description": "自定义需求命令"
    }
  },
  "agent": {
    "architect": {
      "description": "自定义架构师",
      "mode": "subagent",
      "color": "#ff5722",
      "prompt": "自定义 prompt..."
    }
  },
  "skills": {
    "paths": ["./my-custom-skills"]
  }
}

插件不会覆盖已存在的配置 — 如果你在 opencode.json 中定义了同名 command 或 agent，插件的注入将被跳过。

插件自动注入的配置 ​

7 个 Slash Command ​

命令触发 agent说明
/setup—初始化：探测环境、确认 Project Profile
/requirements—需求访谈 → PRD → Parent Issue
/design@architect技术方案 + 必要 ADR → 设计 PR
/tasks@architectDAG 任务拆解 → Sub Issues
/code@developerTask 编码 + TDD → PR
/review@reviewer双轴审查 → 合并
/release—版本提议 → Release PR → tag push → workflow 监控

每个 command 对应一个 flow-* skill，定义在 assets/skills/ 目录中；所有命令共享单一 Stage contract（assets/prompts/stage-contract.md）。

5 个 Agent ​

Agent模式角色
@dev-lifecycleprimary全流程编排器，自动串联各阶段（全权执行 git/gh）
@architectsubagent架构设计、技术方案、DAG 拆解（只写 docs/assets）
@developersubagent技术栈无关代码 TDD 实现（worktree 内开发，不 push）
@reviewersubagent只读代码审查，输出结构化报告
@goal-verifysubagent独立验证 Flow 完成状态（唯一可 complete goal）

8 个 Flow Skills ​

Skill对应命令用途
flow-setup/setup环境初始化 + Profile 确认
flow-requirements/requirements需求分析
flow-design/design技术设计
flow-tasks/tasks任务拆解
flow-code/code编码实现
flow-tdd—TDD 协议唯一来源（advisory，self-report）
flow-review/review代码审查
flow-release/release发布

Skills 被复制到固定目录（~/.config/opencode/cabbage/skills）中运行，不会污染项目目录。

1 个工具：goal ​

插件只注册一个工具 goal，用于会话级 Flow 状态跟踪：

op说明
create建立 goal（绑定 Parent Issue 编号）
get读取当前 goal 状态
pause / resume暂停 / 恢复 goal
cancel取消 goal
complete标记完成（仅 goal-verify 可调用）

目标与验收标准从 Parent Issue body 读取，不存储在 goal 中。

阶段契约 ​

7 个阶段，顺序推进（stage-contract 为单一来源）：

setup → requirements → design → tasks → code → review → release（手动）
  • 阶段完成 = Parent Issue body checklist - [x] <stage>
  • requirements 完成需用户确认一次
  • 设计基线（docs + ADR）合入后才能拆解任务
  • 测试质量由仓库 CI workflow 把关，插件不重复执行

Task DAG ​

任务支持依赖关系。只有所有依赖任务已合并，当前任务才能开始：

yaml
task-1:
  dependsOn: []          # 无依赖，可先执行
task-2:
  dependsOn: [task-1]    # 依赖 task-1
task-3:
  dependsOn: [task-1]    # 依赖 task-1，可与 task-2 并行
task-4:
  dependsOn: [task-2, task-3]  # 依赖前两者都完成

DAG 依赖由编排器（dev-lifecycle）维护，按拓扑顺序分批执行。

文档目录结构 ​

docs/
├── prd/              # 产品需求文档
├── adr/              # 架构决策记录
├── dev/
│   ├── specs/        # 技术方案
│   ├── tasks/        # 任务定义（历史归档）
│   ├── api/          # API 文档
│   ├── db/           # 数据库设计
│   └── guides/       # 开发指南
└── index.md          # 本站首页

工程状态以 GitHub Issues/PRs/Checks 为权威事实，docs/dev/tasks/ 仅保留历史任务记录。

环境要求 ​

工具版本要求用途
Node.js>= 18运行环境
npm>= 9包管理
gh CLI>= 2.0GitHub 操作（Issues/PRs/CI/Releases）
Git>= 2.0版本控制

高级：自定义 Prompt 覆盖 ​

插件支持两级 prompt 加载：项目级 > 内置级。

在项目目录下创建 .opencode/opencode-cabbage/prompts/<name>.md 即可覆盖内置 prompt：

.opencode/
└── opencode-cabbage/
    └── prompts/
        ├── bootstrap.md      # 覆盖启动引导
        ├── PRD-FORMAT.md     # 覆盖 PRD 格式
        └── ADR-FORMAT.md     # 覆盖 ADR 格式