clikit-plugin 0.3.10 → 0.3.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +62 -41
- package/README.md +118 -57
- package/command/create.md +107 -20
- package/command/discuss.md +123 -0
- package/command/handoff.md +7 -5
- package/command/init.md +4 -3
- package/command/pr.md +2 -4
- package/command/research.md +130 -28
- package/command/resume.md +2 -2
- package/command/ship.md +1 -1
- package/command/start.md +12 -11
- package/command/status.md +20 -15
- package/dist/.tsbuildinfo +1 -1
- package/dist/clikit.schema.json +0 -8
- package/dist/config.d.ts +0 -5
- package/dist/config.d.ts.map +1 -1
- package/dist/hooks/index.d.ts +0 -2
- package/dist/hooks/index.d.ts.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -77
- package/memory/_templates/discussion.md +99 -0
- package/memory/_templates/handoff.md +2 -2
- package/memory/_templates/plan.md +83 -176
- package/memory/_templates/research.md +33 -7
- package/memory/_templates/review.md +2 -2
- package/package.json +7 -6
- package/skill/beads/SKILL.md +29 -29
- package/skill/beads/mcp.json +1 -1
- package/skill/beads/references/api-reference.md +8 -3
- package/skill/requesting-code-review/SKILL.md +2 -2
- package/skill/ritual-workflow/SKILL.md +6 -4
- package/src/agents/AGENTS.md +21 -17
- package/src/agents/build.md +61 -63
- package/src/agents/explore.md +14 -14
- package/src/agents/plan.md +238 -94
- package/src/agents/research.md +41 -11
- package/src/agents/review.md +3 -3
- package/command/import-plan.md +0 -175
- package/command/issue.md +0 -109
- package/dist/hooks/tilth-first-guard.d.ts +0 -18
- package/dist/hooks/tilth-first-guard.d.ts.map +0 -1
- package/memory/_digest.md +0 -6
- package/memory/_templates/spec.md +0 -128
- package/memory/beads/.gitkeep +0 -0
- package/memory/handoffs/.gitkeep +0 -0
- package/memory/memory.db +0 -0
- package/memory/plans/.gitkeep +0 -0
- package/memory/prds/.gitkeep +0 -0
- package/memory/research/.gitkeep +0 -0
- package/memory/reviews/.gitkeep +0 -0
- package/memory/specs/.gitkeep +0 -0
package/AGENTS.md
CHANGED
|
@@ -4,24 +4,27 @@ An OpenCode plugin that provides agents, commands, skills, hooks, and a memory s
|
|
|
4
4
|
|
|
5
5
|
## How It Works
|
|
6
6
|
|
|
7
|
-
The plugin (`src/index.ts`) loads agents from `src/agents/*.md`, commands from `command/*.md`, and skills from `skill/*/SKILL.md`. Runtime hooks in `src/hooks/` intercept tool execution for safety (git guard, security scan) and quality (typecheck, formatting). Configuration
|
|
7
|
+
The plugin (`src/index.ts`) loads agents from `src/agents/*.md`, commands from `command/*.md`, and skills from `skill/*/SKILL.md`. Runtime hooks in `src/hooks/` intercept tool execution for safety (git guard, security scan) and quality (typecheck, formatting). Configuration prefers `clikit.jsonc` or `clikit.json`; legacy `clikit.config.json` remains supported for backward compatibility.
|
|
8
8
|
|
|
9
9
|
## Workflow
|
|
10
10
|
|
|
11
11
|
**Quick mode** (simple features):
|
|
12
12
|
```
|
|
13
|
-
/create → /start → /verify → /ship
|
|
13
|
+
/discuss → /create → /start → /verify → /ship
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
**Deep mode** (complex features, research, UI):
|
|
17
17
|
```
|
|
18
|
-
/
|
|
18
|
+
/discuss → /create → /design → /start → /verify → /ship
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
- `/
|
|
22
|
-
- `/
|
|
23
|
-
- `/
|
|
21
|
+
- `/discuss` captures user intent and writes a planning-ready discussion artifact
|
|
22
|
+
- `/create` reads discussion context, runs a mandatory pre-plan research pass, then produces a single XML-structured plan — `/start` works directly from this output
|
|
23
|
+
- `/start` executes packet-by-packet and embeds the execute + verify loop in compressed mode
|
|
24
|
+
- `/verify` is the deeper optional audit / pre-ship gate — run before `/ship` finalizes and lands shared-checkout changes
|
|
25
|
+
- `/research` = optional standalone research command — read discussion context, close decision gaps with external evidence, and write a planning-ready report
|
|
24
26
|
- `/design` = UI/UX design and implementation (uses Vision agent)
|
|
27
|
+
- Execution happens one **Task Packet** at a time (1 concern, 1–3 files, one verify bundle)
|
|
25
28
|
|
|
26
29
|
## Where to Find Things
|
|
27
30
|
|
|
@@ -29,9 +32,9 @@ The plugin (`src/index.ts`) loads agents from `src/agents/*.md`, commands from `
|
|
|
29
32
|
- **Commands**: `command/*.md` — each slash command's template and instructions.
|
|
30
33
|
- **Skills**: `skill/*/SKILL.md` — load relevant skills before tasks. List available skills with `ls skill/`.
|
|
31
34
|
- **Schemas**: `@.opencode/schemas.md` — canonical schemas for tasks, beads, delegation, artifacts, and Task Packets.
|
|
32
|
-
- **Templates**: `memory/_templates/*.md` — templates for
|
|
33
|
-
- **Memory**: `memory/_digest.md` (auto-generated from SQLite observations on session start), plus `memory/
|
|
34
|
-
- **Config**: `clikit.config.json`
|
|
35
|
+
- **Templates**: `memory/_templates/*.md` — templates for discussions, plans, research, reviews, handoffs, PRDs.
|
|
36
|
+
- **Memory**: `memory/_digest.md` (auto-generated from SQLite observations on session start), plus `memory/discussions/`, `memory/plans/`, `memory/research/`, `memory/handoffs/`, `memory/reviews/`, `memory/prds/`.
|
|
37
|
+
- **Config**: `.opencode/clikit.jsonc` or `.opencode/clikit.json` (preferred); `clikit.config.json` remains a legacy fallback.
|
|
35
38
|
- **Full docs**: `@.opencode/README.md` — complete reference for all agents, commands, skills, hooks, and config options.
|
|
36
39
|
|
|
37
40
|
## Context Management (DCP Beta)
|
|
@@ -74,6 +77,7 @@ Load `session-management` skill for full threshold handling (including handoff t
|
|
|
74
77
|
bun install # dependencies
|
|
75
78
|
bun run build # compile plugin
|
|
76
79
|
bun run typecheck # type check
|
|
80
|
+
bun run verify # full local verification
|
|
77
81
|
bun run dev # watch mode
|
|
78
82
|
```
|
|
79
83
|
|
|
@@ -86,23 +90,38 @@ bun run dev # watch mode
|
|
|
86
90
|
- Memory tools in `src/tools/` are library code used by hooks, not registered as agent tools
|
|
87
91
|
- Never force push without `--force-with-lease`
|
|
88
92
|
|
|
89
|
-
##
|
|
93
|
+
## Tilth Navigation Policy
|
|
90
94
|
|
|
91
|
-
|
|
95
|
+
When agents navigate files or search the codebase, use **tilth CLI first**.
|
|
92
96
|
|
|
93
|
-
|
|
97
|
+
Fallback order:
|
|
98
|
+
|
|
99
|
+
```text
|
|
100
|
+
tilth CLI → read → grep → glob
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
- Use `read` once the target file is narrowed and you need raw content
|
|
104
|
+
- Use `grep` for text-pattern fallback when tilth did not answer the question
|
|
105
|
+
- Use `glob` only for explicit path enumeration
|
|
106
|
+
- Use LSP after navigation when semantic confirmation is required
|
|
107
|
+
|
|
108
|
+
This is a documented agent rule, not a hard runtime block.
|
|
109
|
+
|
|
110
|
+
## Issue Tracking with Beads Rust (`br`)
|
|
111
|
+
|
|
112
|
+
**IMPORTANT**: This project now prefers **Beads Rust** (`br`) with local `.beads/` storage for persistent task tracking. Do NOT use markdown TODOs or ad-hoc task lists as the source of truth.
|
|
113
|
+
|
|
114
|
+
### Preferred Interface
|
|
94
115
|
|
|
95
116
|
| Interface | Who Uses It | How |
|
|
96
117
|
|-----------|-------------|-----|
|
|
97
|
-
| **`
|
|
98
|
-
| **`beads-village_*` MCP** |
|
|
99
|
-
|
|
100
|
-
**AI agents must use `beads-village_*` MCP tools — never shell `bd` commands.**
|
|
118
|
+
| **`br` CLI** | User and agents | `br init`, `br ready --json`, `br create`, `br update`, `br close`, `br sync` |
|
|
119
|
+
| **`beads-village_*` MCP** | Optional legacy compatibility | Use only if already installed and explicitly needed for reservations/messages |
|
|
101
120
|
|
|
102
121
|
### Agent Core Cycle
|
|
103
122
|
|
|
104
123
|
```
|
|
105
|
-
|
|
124
|
+
br init → br ready --json → br show/list --json → br create (if needed) → br update --status in_progress --claim → work → verify → br close → br sync --flush-only
|
|
106
125
|
```
|
|
107
126
|
|
|
108
127
|
In compressed workflow, the execution unit is a **Task Packet**:
|
|
@@ -115,33 +134,35 @@ In compressed workflow, the execution unit is a **Task Packet**:
|
|
|
115
134
|
|
|
116
135
|
| Tool | Purpose |
|
|
117
136
|
|------|---------|
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
121
|
-
| `
|
|
122
|
-
| `
|
|
123
|
-
| `
|
|
124
|
-
| `
|
|
125
|
-
| `
|
|
126
|
-
| `
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|---|---|
|
|
134
|
-
| `beads-village_ready` | `beads-village_ls(status="ready")` |
|
|
135
|
-
| `beads-village_broadcast` | `beads-village_msg(global=true, to="all")` |
|
|
136
|
-
| `beads-village_discover` | `beads-village_status(include_agents=true)` |
|
|
137
|
+
| `br init` | Initialize `.beads/` for the project |
|
|
138
|
+
| `br ready --json` | List unblocked claimable work |
|
|
139
|
+
| `br create --title ... --description ... --type ... --priority ...` | Create issue |
|
|
140
|
+
| `br update <id> --status in_progress --claim` | Claim / start work |
|
|
141
|
+
| `br show <id> --json` | Read task details |
|
|
142
|
+
| `br list --json` | Inspect task inventory |
|
|
143
|
+
| `br close <id> --reason "Completed" --json` | Close completed work |
|
|
144
|
+
| `br sync --flush-only` | Flush `.beads/` state before git commit/push |
|
|
145
|
+
| `br sync --import-only` | Re-import `.beads/` state after pull/rebase |
|
|
146
|
+
|
|
147
|
+
### Legacy compatibility note
|
|
148
|
+
|
|
149
|
+
- `beads-village_*` is no longer the default required workflow in this repo.
|
|
150
|
+
- If a local setup still depends on `beads-village` for reservations or inbox-style coordination, treat it as optional compatibility, not the primary task tracker.
|
|
151
|
+
- This repo does **not** currently provide a full MCP replacement for `br`; use the CLI-first workflow above.
|
|
137
152
|
|
|
138
153
|
### Policy
|
|
139
154
|
|
|
140
155
|
- Trivial (< 2 min, 1-line fix): skip Beads, just do it
|
|
141
|
-
- Non-trivial:
|
|
142
|
-
- `todowrite` = in-session UI display only —
|
|
156
|
+
- Non-trivial: prefer `br` issue first → claim/start → work → close
|
|
157
|
+
- `todowrite` = in-session UI display only — `.beads/` is the persistent execution state when task tracking is in use
|
|
143
158
|
- Work in the shared checkout on the repo default branch — no git worktrees or per-task branches unless the user explicitly requests them
|
|
144
159
|
- Check `git status --short --branch` before editing; if overlapping local changes already exist in your scope, stop and coordinate instead of isolating the work
|
|
145
|
-
-
|
|
146
|
-
-
|
|
147
|
-
- Call `
|
|
160
|
+
- If optional `beads-village` reservations are available, you may use them to surface conflicts early in the shared workspace
|
|
161
|
+
- Otherwise coordinate through git state, handoffs, and explicit file scope instead of assuming reservations exist
|
|
162
|
+
- Call `br close` before ending a completed tracked session; for mid-task handoff, leave the issue open and hand off without closing it
|
|
163
|
+
|
|
164
|
+
### Nested Repository Note
|
|
165
|
+
|
|
166
|
+
- In this workspace, `.opencode/` is treated as its own nested git repository
|
|
167
|
+
- The outer repo often only shows `.opencode` as modified, while detailed diffs live inside the nested `.opencode` repo
|
|
168
|
+
- It is not currently configured as a normal `.gitmodules` submodule, so inspect both git layers when auditing docs or code changes
|
package/README.md
CHANGED
|
@@ -1,59 +1,124 @@
|
|
|
1
1
|
# CliKit Plugin for OpenCode
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Turn raw OpenCode into a disciplined delivery workflow: **discuss → create → start → verify → ship**.
|
|
4
|
+
|
|
5
|
+
CliKit is the workflow layer for OpenCode — curated agents, slash commands, runtime hooks, memory artifacts, and quality gates that help you move from vague request to verified change without inventing your process every session.
|
|
6
|
+
|
|
7
|
+
## Why CliKit exists
|
|
8
|
+
|
|
9
|
+
OpenCode is powerful, but the hard part is not calling a model — it is keeping planning, execution, verification, and handoff aligned as the task gets bigger.
|
|
10
|
+
|
|
11
|
+
CliKit adds that missing structure:
|
|
12
|
+
|
|
13
|
+
- **Workflow orchestration** — opinionated commands for discuss/create/start/verify/ship
|
|
14
|
+
- **Agent library** — specialized roles for build, plan, explore, review, research, oracle, and vision
|
|
15
|
+
- **Memory system** — discussion, plan, research, review, and handoff artifacts that survive across sessions
|
|
16
|
+
- **Safety + quality hooks** — git guard, security checks, truncation, memory digest, and prompt-context helpers
|
|
17
|
+
- **Verification loop** — compressed packet execution plus explicit verification before landing changes
|
|
18
|
+
|
|
19
|
+
## Start here
|
|
20
|
+
|
|
21
|
+
### Install in 3 steps
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# 1) Install Beads Rust for local task tracking
|
|
25
|
+
br --version
|
|
26
|
+
|
|
27
|
+
# 2) Initialize tracker state in your project
|
|
28
|
+
br init
|
|
29
|
+
|
|
30
|
+
# 3) Install CliKit for OpenCode
|
|
31
|
+
bun x clikit-plugin install
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Need the full install notes, Windows binary path, or MCP details? Jump to [Installation](#installation).
|
|
35
|
+
|
|
36
|
+
### Pick a workflow
|
|
37
|
+
|
|
38
|
+
**Quick feature / fix**
|
|
39
|
+
```text
|
|
40
|
+
/discuss → /create → /start → /verify → /ship
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Deeper feature / research-heavy change**
|
|
44
|
+
```text
|
|
45
|
+
/discuss → /create → /design → /start → /verify → /ship
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Audit existing work before landing**
|
|
49
|
+
```text
|
|
50
|
+
/verify → /ship
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## What you get
|
|
54
|
+
|
|
55
|
+
- **7 specialized agents** — build, plan, explore, review, vision, oracle, research
|
|
56
|
+
- **14 slash commands** — including `/discuss`, `/create`, `/start`, `/verify`, `/ship`, `/debug`, `/research`, `/design`, `/status`
|
|
57
|
+
- **26 workflow skills** — planning, debugging, testing, integration, and session-management skills
|
|
58
|
+
- **11 runtime hooks/modules** — git guard, security check, truncator, memory digest, beads context, tilth reading, and more
|
|
59
|
+
- **Structured memory** — templates plus saved discussions, plans, research, reviews, handoffs, and PRDs
|
|
60
|
+
- **Configurable runtime** — per-agent overrides, hook toggles, workflow mode selection, and extended permissions
|
|
61
|
+
|
|
62
|
+
## Trust & compatibility
|
|
63
|
+
|
|
64
|
+
- **OpenCode-first** plugin architecture
|
|
65
|
+
- **Compressed workflow** with packetized execution and embedded verification
|
|
66
|
+
- **Beads Rust (`br`)** as the preferred local tracker workflow
|
|
67
|
+
- **Shared-workspace friendly** defaults with optional legacy `beads-village` compatibility
|
|
68
|
+
- **Published package**: [`clikit-plugin` on npm](https://www.npmjs.com/package/clikit-plugin)
|
|
69
|
+
|
|
70
|
+
## Docs map
|
|
71
|
+
|
|
72
|
+
- `README.md` — install, workflows, commands, skills, config
|
|
73
|
+
- `AGENTS.md` — repo-wide execution policy and tracker workflow
|
|
74
|
+
- `command/` — slash command definitions and execution rules
|
|
75
|
+
- `src/agents/` — agent prompts and behavior contracts
|
|
76
|
+
- `skill/` — reusable workflow skills
|
|
77
|
+
- `schemas.md` — canonical packet / artifact / tracker schemas
|
|
78
|
+
- `memory/_templates/` — discussion, plan, research, review, PRD, and handoff templates
|
|
79
|
+
|
|
80
|
+
---
|
|
4
81
|
|
|
5
82
|
## Features
|
|
6
83
|
|
|
7
84
|
- **7 Specialized Agents**: build, plan, explore, review, vision, oracle, research
|
|
8
|
-
- **
|
|
9
|
-
- **
|
|
85
|
+
- **14 Slash Commands**: /discuss, /create, /start, /ship, /verify, /debug, /design, /research, /commit, /pr, and more
|
|
86
|
+
- **26 Workflow Skills**: TDD, debugging, research, integrations, ritual-workflow, and more
|
|
10
87
|
- **7 Internal Utilities**: memory (read/search/get/timeline/update/admin), observation, context-summary, cass-memory (used by hooks, not directly registered as agent tools)
|
|
11
|
-
- **
|
|
12
|
-
- **Memory System**: Templates,
|
|
88
|
+
- **11 Runtime Hooks/Modules**: todo enforcer, empty output sanitizer, git guard, security check, subagent blocker, truncator, memory digest, todo→beads sync, beads-context, cass-memory, and tilth-reading
|
|
89
|
+
- **Memory System**: Templates, discussions, plans, research artifacts with FTS5 search
|
|
13
90
|
- **Extended Permissions**: doom_loop, external_directory controls
|
|
14
91
|
- **Configurable**: Enable/disable agents, override models, customize behavior
|
|
15
92
|
|
|
16
93
|
## Installation
|
|
17
94
|
|
|
18
|
-
### Step 1 — Install Beads (
|
|
95
|
+
### Step 1 — Install Beads Rust (`br`)
|
|
19
96
|
|
|
20
|
-
CliKit
|
|
97
|
+
CliKit now prefers [beads_rust](https://github.com/Dicklesworthstone/beads_rust) (`br`) for persistent task tracking in `.beads/`. Classic `bd` + Dolt are no longer required for the default workflow.
|
|
21
98
|
|
|
22
|
-
**Windows (
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
99
|
+
**Windows (native binary):**
|
|
100
|
+
1. Download the latest `br-v*-windows_amd64.zip` asset from the GitHub Releases page.
|
|
101
|
+
2. Extract `br.exe`.
|
|
102
|
+
3. Place it on your `PATH` (for example under `%APPDATA%\npm`).
|
|
26
103
|
|
|
27
|
-
**macOS / Linux
|
|
104
|
+
**macOS / Linux / Windows via WSL:**
|
|
28
105
|
```bash
|
|
29
|
-
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
**npm / bun:**
|
|
33
|
-
```bash
|
|
34
|
-
npm install -g @beads/bd
|
|
35
|
-
# or
|
|
36
|
-
bun install -g --trust @beads/bd
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
**go install (Go 1.24+ required):**
|
|
40
|
-
```bash
|
|
41
|
-
go install github.com/steveyegge/beads/cmd/bd@latest
|
|
106
|
+
curl -fsSL "https://raw.githubusercontent.com/Dicklesworthstone/beads_rust/main/install.sh" | bash
|
|
42
107
|
```
|
|
43
108
|
|
|
44
109
|
Verify:
|
|
45
110
|
```bash
|
|
46
|
-
|
|
111
|
+
br --version
|
|
47
112
|
```
|
|
48
113
|
|
|
49
|
-
### Step 2 — Initialize
|
|
114
|
+
### Step 2 — Initialize `.beads/` in your project
|
|
50
115
|
|
|
51
116
|
```bash
|
|
52
117
|
cd your-project
|
|
53
|
-
|
|
118
|
+
br init
|
|
54
119
|
```
|
|
55
120
|
|
|
56
|
-
This creates the `.beads/`
|
|
121
|
+
This creates the `.beads/` task-tracking directory. Do this once per project. If `.beads/` already exists, keep it and use `br sync --import-only` after pulling or rebasing older state.
|
|
57
122
|
|
|
58
123
|
### Step 3 — Install CliKit
|
|
59
124
|
|
|
@@ -68,11 +133,12 @@ The plugin is registered in `~/.config/opencode/opencode.json`.
|
|
|
68
133
|
|
|
69
134
|
CliKit injects default MCP server entries at runtime when missing:
|
|
70
135
|
|
|
71
|
-
- `beads-village` (`npx beads-village`) — requires `bd init` to have been run in the project
|
|
72
136
|
- `context7` (`https://mcp.context7.com/mcp`)
|
|
73
137
|
- `grep` (`https://mcp.grep.app`)
|
|
74
138
|
- `human-mcp` (`npx @goonnguyen/human-mcp`)
|
|
75
139
|
|
|
140
|
+
`beads-village` is no longer injected by default. If you still rely on the legacy MCP workflow for reservations or inbox-style coordination, add it manually.
|
|
141
|
+
|
|
76
142
|
Recommended environment variables:
|
|
77
143
|
|
|
78
144
|
- `CONTEXT7_API_KEY` for Context7
|
|
@@ -84,23 +150,24 @@ After installation, use these commands:
|
|
|
84
150
|
|
|
85
151
|
**Quick mode** (simple features):
|
|
86
152
|
```
|
|
87
|
-
/create → /start → /verify → /ship
|
|
153
|
+
/discuss → /create → /start → /verify → /ship
|
|
88
154
|
```
|
|
89
155
|
|
|
90
156
|
**Deep mode** (complex features, research, UI):
|
|
91
157
|
```
|
|
92
|
-
/
|
|
158
|
+
/discuss → /create → /design → /start → /verify → /ship
|
|
93
159
|
```
|
|
94
160
|
|
|
95
161
|
Workflow notes:
|
|
96
|
-
- All
|
|
97
|
-
- `/
|
|
162
|
+
- All 14 commands work **standalone** — the pipeline is recommended, not required
|
|
163
|
+
- `/discuss` runs a pre-create discussion phase — clarify intent, confirm assumptions, and save a planning-ready discussion artifact
|
|
164
|
+
- `/create` explores codebase first, consumes discussion context, runs a mandatory pre-plan research pass, then produces a single XML-structured plan
|
|
98
165
|
- `/start` executes the plan, one Task Packet at a time — creates a minimal inline plan if none exists
|
|
99
166
|
- `/verify` runs all 4 gates (typecheck, tests, lint, build) + deep review — use anytime, not just pre-ship
|
|
100
167
|
- `/ship` finalizes work in the shared checkout — commit, sync, and land on the repo default branch; `/pr` is optional and only for explicit PR-based exceptions
|
|
101
|
-
- `/research`
|
|
168
|
+
- `/research` is an optional standalone research command — it reads discussion context first, closes decision gaps with external evidence, and saves a planning-ready report
|
|
102
169
|
- `/design` implements UI/UX with variant exploration and a11y — uses Vision agent
|
|
103
|
-
-
|
|
170
|
+
- `br` + `.beads/` is the preferred persistent task source of truth; `beads-village` is optional legacy compatibility only
|
|
104
171
|
- Plans decompose work into **Task Packets** (1 concern, 1–3 files, one verify bundle)
|
|
105
172
|
|
|
106
173
|
## Configuration
|
|
@@ -149,7 +216,6 @@ Project config overrides user config.
|
|
|
149
216
|
"git_guard": { "enabled": true },
|
|
150
217
|
"security_check": { "enabled": true },
|
|
151
218
|
"subagent_question_blocker": { "enabled": true },
|
|
152
|
-
"tilth_first_guard": { "enabled": true, "log": false },
|
|
153
219
|
"truncator": { "enabled": true, "packet_friendly": true },
|
|
154
220
|
"memory_digest": { "enabled": true, "compact_mode": true },
|
|
155
221
|
"todo_beads_sync": { "enabled": false, "mode": "disabled" },
|
|
@@ -190,11 +256,10 @@ Project config overrides user config.
|
|
|
190
256
|
| `git_guard` | on | Blocks dangerous git commands (force push, hard reset, rm -rf) |
|
|
191
257
|
| `security_check` | on | Scans for secrets/credentials before git commits |
|
|
192
258
|
| `subagent_question_blocker` | on | Prevents subagents from asking clarifying questions |
|
|
193
|
-
| `tilth_first_guard` | on | Requires `@explore` to make an explicit `tilth` CLI attempt before `read` / `grep` / `glob` fallback |
|
|
194
259
|
| `truncator` | on | Truncates large outputs to prevent context overflow |
|
|
195
260
|
| `memory_digest` | on | Generates `memory/_digest.md` index + topic files (`decision.md`, `learning.md`, etc.) from SQLite observations |
|
|
196
|
-
| `todo_beads_sync` | off | Legacy
|
|
197
|
-
| `beads_context` | on | Injects active
|
|
261
|
+
| `todo_beads_sync` | off | Legacy compatibility mirror for syncing todos into `.beads/` exports |
|
|
262
|
+
| `beads_context` | on | Injects active `.beads/` task state into prompts when local Beads data exists |
|
|
198
263
|
| `cass_memory` | on | Loads embedded memory context on session start and runs idle reflection (`cassMemoryContext`, `cassMemoryReflect`) |
|
|
199
264
|
| `tilth_reading` | on | Enhances `read` tool output via tilth when available for smarter file reads |
|
|
200
265
|
|
|
@@ -203,9 +268,9 @@ Project config overrides user config.
|
|
|
203
268
|
| Agent | Mode | Description |
|
|
204
269
|
|-------|------|-------------|
|
|
205
270
|
| `build` | primary | Primary code executor, implements plans |
|
|
206
|
-
| `plan` | primary |
|
|
271
|
+
| `plan` | primary | Handles `/discuss` intent locking and `/create` planning, producing discussion artifacts and XML-structured plans |
|
|
207
272
|
| `oracle` | subagent | Deep code inspection + architecture trade-off analysis |
|
|
208
|
-
| `research` | subagent | External
|
|
273
|
+
| `research` | subagent | External evidence specialist; writes research artifacts for `/research` and Plan's pre-plan pass |
|
|
209
274
|
| `explore` | subagent | Fast codebase exploration |
|
|
210
275
|
| `review` | subagent | Code review & quality gate |
|
|
211
276
|
| `vision` | subagent | Design direction + visual implementation |
|
|
@@ -214,13 +279,14 @@ Default active roles in compressed workflow: `build`, `plan`, `review`, plus coo
|
|
|
214
279
|
|
|
215
280
|
## Commands
|
|
216
281
|
|
|
217
|
-
Run with `/command-name` in OpenCode. **All
|
|
282
|
+
Run with `/command-name` in OpenCode. **All 14 commands work standalone** — the pipeline is a recommended flow, not a requirement.
|
|
218
283
|
|
|
219
284
|
### Workflow pipeline
|
|
220
285
|
| Command | Standalone? | One-liner |
|
|
221
286
|
|---------|-------------|-----------|
|
|
222
|
-
| `/
|
|
223
|
-
| `/
|
|
287
|
+
| `/discuss` | ✅ | Pre-create discussion phase — lock intent, confirm assumptions, save planning-ready artifact |
|
|
288
|
+
| `/create` | ✅ | Explore codebase → load discussion context → run mandatory pre-plan research → produce a single XML-structured plan |
|
|
289
|
+
| `/research` | ✅ | Optional standalone research pass — read discussion context, gather evidence, save planning-ready report |
|
|
224
290
|
| `/design` | ✅ | UI/UX design + implementation — variant exploration, a11y, responsive (Vision agent) |
|
|
225
291
|
| `/start` | ✅ | Execute plan packets — creates minimal inline plan if none exists |
|
|
226
292
|
| `/ship` | ✅ | Commit + land shared-checkout changes on the default branch — self-review built in, `/verify` recommended |
|
|
@@ -230,14 +296,12 @@ Run with `/command-name` in OpenCode. **All 15 commands work standalone** — th
|
|
|
230
296
|
| Command | One-liner |
|
|
231
297
|
|---------|-----------|
|
|
232
298
|
| `/debug` | Reproduce → 5-Whys root cause → fix → regression test |
|
|
233
|
-
| `/
|
|
234
|
-
| `/status` | Workspace snapshot — Beads tasks, git state, active artifacts |
|
|
299
|
+
| `/status` | Workspace snapshot — task tracker state, git state, active artifacts |
|
|
235
300
|
| `/init` | Bootstrap CliKit — scaffold dirs + write tailored AGENTS.md |
|
|
236
301
|
| `/handoff` | Auto-capture session state for graceful pause |
|
|
237
302
|
| `/resume` | Pick up cold from latest handoff, no warm-up questions |
|
|
238
303
|
| `/commit` | Auto-detect type/scope → perfect Conventional Commit message |
|
|
239
304
|
| `/pr` | Optional PR flow for explicit branch-based review exceptions |
|
|
240
|
-
| `/import-plan` | Import Jira/Notion/Linear tasks → Beads issues + plan |
|
|
241
305
|
|
|
242
306
|
## Skills
|
|
243
307
|
|
|
@@ -280,7 +344,7 @@ Run with `/command-name` in OpenCode. **All 15 commands work standalone** — th
|
|
|
280
344
|
### Integration & Collaboration (6)
|
|
281
345
|
| Skill | Use When |
|
|
282
346
|
|-------|----------|
|
|
283
|
-
| `beads` | Multi-agent task coordination
|
|
347
|
+
| `beads` | Multi-agent task coordination with `br` and optional legacy beads-village helpers |
|
|
284
348
|
| `playwright` | Browser automation and E2E testing |
|
|
285
349
|
| `chrome-devtools` | Web debugging and performance analysis |
|
|
286
350
|
| `requesting-code-review` | After completing a task |
|
|
@@ -299,9 +363,6 @@ bun run build
|
|
|
299
363
|
# Type check
|
|
300
364
|
bun run typecheck
|
|
301
365
|
|
|
302
|
-
# Unit tests
|
|
303
|
-
bun run test
|
|
304
|
-
|
|
305
366
|
# Full local verification
|
|
306
367
|
bun run verify
|
|
307
368
|
|
|
@@ -318,19 +379,19 @@ bun run dev
|
|
|
318
379
|
│ ├── config.ts # Config loader
|
|
319
380
|
│ ├── types.ts # Type definitions
|
|
320
381
|
│ ├── agents/ # Agent loaders
|
|
321
|
-
│ ├──
|
|
382
|
+
│ ├── skill/ # Skill loaders
|
|
322
383
|
│ ├── tools/ # Internal utilities (memory, context-summary, cass-memory)
|
|
323
|
-
│ └── hooks/ # Runtime hooks (
|
|
384
|
+
│ └── hooks/ # Runtime hooks (11 modules + index)
|
|
324
385
|
├── skill/ # Skill definitions (*.md)
|
|
325
386
|
├── command/ # Command definitions (*.md)
|
|
326
387
|
├── memory/ # Memory system
|
|
327
|
-
│ ├── _templates/ # Document templates
|
|
328
|
-
│ ├──
|
|
388
|
+
│ ├── _templates/ # Document templates (discussion, plan, research, handoff, review, PRD)
|
|
389
|
+
│ ├── discussions/ # Discussion artifacts
|
|
329
390
|
│ ├── plans/ # Implementation plans
|
|
330
391
|
│ ├── research/ # Research artifacts
|
|
331
392
|
│ ├── reviews/ # Code reviews
|
|
332
393
|
│ ├── handoffs/ # Session handoffs
|
|
333
|
-
│ ├── beads/ #
|
|
394
|
+
│ ├── beads/ # Optional compatibility bead metadata
|
|
334
395
|
│ └── prds/ # Product requirements
|
|
335
396
|
└── clikit.jsonc
|
|
336
397
|
```
|