@evolvehq/docflow 0.6.0 → 0.7.1

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.
Files changed (3) hide show
  1. package/README.md +65 -7
  2. package/USAGE.md +89 -21
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,8 +2,9 @@
2
2
 
3
3
  ![docflow — ADR-driven documentation workflow](docs/preview.png)
4
4
 
5
- A plugin for **ADR-driven, documentation-led projects**, working on both
6
- the **pi** and **Claude Code** coding agents from the same skill files.
5
+ A plugin for **ADR-driven, documentation-led projects**, working on
6
+ **Claude Code, Claude Cowork, pi, Codex, and OpenCode** from the same
7
+ skill files (see [Install](#install)).
7
8
  It installs a `bootstrap` skill that scaffolds (or retrofits) an
8
9
  **Architecture Decision Record (ADR)** catalogue, a plan queue, and
9
10
  `AGENTS.md` conventions into any repository, plus a set of **lifecycle
@@ -66,9 +67,22 @@ rather than overwriting them).
66
67
 
67
68
  ## Install
68
69
 
69
- docflow ships for two coding agents from the **same** skill files — only
70
- the manifest differs (`.claude-plugin/` for Claude Code, `package.json`
71
- for pi).
70
+ docflow ships from **one `skills/` tree** to five coding agents — only
71
+ the packaging differs. Two surfaces: the scaffolded **output**
72
+ (`AGENTS.md`, the ADR catalogue, `plan/`, `_agent/`) is plain Markdown
73
+ read natively by any agent that loads `AGENTS.md`; the **skills** are
74
+ `SKILL.md` files the host discovers.
75
+
76
+ | Agent | Output | Skills | Install | Invoke |
77
+ |-------|:------:|:------:|---------|--------|
78
+ | Claude Code | native | ✅ | marketplace (below) | `/bootstrap` |
79
+ | Claude Cowork | native | ✅ | same Claude Code plugin | `/bootstrap` |
80
+ | pi | native | ✅ | `pi install npm:@evolvehq/docflow` | `/skill:bootstrap` |
81
+ | Codex | native | ✅ | `codex plugin marketplace add EvolveHQ/docflow` | `$bootstrap` / `/skills` |
82
+ | OpenCode | native | ✅ | auto-discovered, or symlink into `~/.config/opencode/skills` | auto, by description |
83
+
84
+ Handy: OpenCode also reads `~/.claude/skills/` and `~/.agents/skills/`, so
85
+ a shared skills directory can serve it alongside another agent.
72
86
 
73
87
  ### Claude Code — from this marketplace
74
88
 
@@ -80,6 +94,13 @@ for pi).
80
94
  Invoke with `/bootstrap`, `/new-adr`, `/ship-item`, … (auto-triggers on
81
95
  matching requests too).
82
96
 
97
+ ### Claude Cowork
98
+
99
+ Cowork uses the **same plugin system** as Claude Code, so install the
100
+ docflow plugin exactly as above (`/plugin marketplace add
101
+ EvolveHQ/docflow`, then install) — or from Anthropic's community
102
+ marketplace once listed. No separate packaging.
103
+
83
104
  ### pi coding agent
84
105
 
85
106
  ```
@@ -97,6 +118,39 @@ The scaffolded output (`AGENTS.md`, `CONVENTIONS.md`, the ADR catalogue,
97
118
  `plan/`, `_agent/`) is plain Markdown and is read natively by pi's
98
119
  hierarchical `AGENTS.md` loading — no porting needed.
99
120
 
121
+ ### Codex (OpenAI)
122
+
123
+ docflow ships a Codex plugin (`.codex-plugin/`), so it's a one-command
124
+ install from this repo's marketplace:
125
+
126
+ ```
127
+ codex plugin marketplace add EvolveHQ/docflow
128
+ codex plugin install docflow
129
+ ```
130
+
131
+ Codex reads the scaffolded `AGENTS.md` natively. Invoke with `$bootstrap`
132
+ / `/skills`, or just describe the task (Codex auto-triggers from the skill
133
+ description); the assessment questions fall back to plain `A/B/C` text
134
+ where there is no select tool. Update later with `codex plugin
135
+ marketplace upgrade`.
136
+
137
+ ### OpenCode (sst)
138
+
139
+ OpenCode auto-discovers skills from `.claude/skills`, `.agents/skills`,
140
+ and `.opencode/skills` (project and global) — so **if you already run
141
+ docflow on Claude Code or Codex via a shared skills directory, OpenCode
142
+ picks it up with no extra step.** Standalone, symlink the skills into
143
+ OpenCode's global directory (one command, stays in sync with the clone):
144
+
145
+ ```
146
+ git clone https://github.com/EvolveHQ/docflow ~/.docflow-src
147
+ ln -s ~/.docflow-src/skills/* ~/.config/opencode/skills/
148
+ ```
149
+
150
+ OpenCode has no marketplace command for `SKILL.md` skills (its plugin
151
+ system is for npm JS plugins), so a shared skills directory is the clean
152
+ path. Skills auto-load by description.
153
+
100
154
  ### Claude Code — local development (no install)
101
155
 
102
156
  ```
@@ -161,10 +215,14 @@ to extend or override the templates.
161
215
  ```
162
216
  docflow/
163
217
  .claude-plugin/
164
- plugin.json # Claude Code plugin manifest
218
+ plugin.json # Claude Code / Cowork plugin manifest
165
219
  marketplace.json # Claude Code marketplace listing (repo is its own marketplace)
220
+ .codex-plugin/
221
+ plugin.json # Codex plugin manifest (skills -> ./skills)
222
+ .agents/plugins/
223
+ marketplace.json # Codex marketplace listing
166
224
  package.json # pi package manifest (pi.skills -> ./skills) + npm metadata
167
- skills/
225
+ skills/ # the one skill source, shared by every target
168
226
  bootstrap/
169
227
  SKILL.md # bootstrap: assessment + output sequence + backfill
170
228
  templates/ # files the bootstrap reads and writes into target repos
package/USAGE.md CHANGED
@@ -5,21 +5,58 @@ what each of the 10 assessment questions actually changes in the
5
5
  output, and how to customise or extend the templates. The lifecycle
6
6
  skills are covered in §5a.
7
7
 
8
- For installation, see the [README](README.md).
9
-
10
- ## 1. Triggering the bootstrap skill
11
-
12
- Once the plugin is installed (or `--plugin-dir`'d) into a Claude Code
13
- session, the skill is available in any repo. Three ways to trigger:
14
-
15
- 1. **Slash command:** `/bootstrap`.
16
- 2. **Natural language** matching the skill's description, e.g.
17
- - "set up documentation-led conventions in this repo"
18
- - "bootstrap ADRs and a plan queue"
19
- - "scaffold AGENTS.md and the _agent/ layout"
20
- - "retrofit this existing repo with the documentation conventions"
21
- 3. **From another agent's prompt** name the skill explicitly:
22
- *"invoke the `bootstrap` skill on this repository."*
8
+ ## Install (per platform)
9
+
10
+ docflow runs from **one `skills/` tree** on five coding agents. The
11
+ scaffolded **output** (`AGENTS.md`, the ADR catalogue, `plan/`, `_agent/`)
12
+ is plain Markdown read natively by any agent that loads `AGENTS.md`; the
13
+ **skills** are `SKILL.md` files the host discovers.
14
+
15
+ | Agent | Install | Invoke |
16
+ |-------|---------|--------|
17
+ | **Claude Code** | `/plugin marketplace add EvolveHQ/docflow` then `/plugin install docflow@evolvehq` | `/bootstrap` |
18
+ | **Claude Cowork** | the **same** Claude Code plugin (`/plugin marketplace add …`) — Cowork shares the plugin system | `/bootstrap` |
19
+ | **pi** | `pi install npm:@evolvehq/docflow` (or `pi install git:github.com/EvolveHQ/docflow`) | `/skill:bootstrap` |
20
+ | **Codex** | `codex plugin marketplace add EvolveHQ/docflow` then `codex plugin install docflow` (native plugin) | `$bootstrap` / `/skills` |
21
+ | **OpenCode** | auto-discovers `.claude`/`.agents`/`.opencode` skills (so a Claude Code / Codex install is picked up), or symlink into `~/.config/opencode/skills` | auto, by description |
22
+
23
+ Notes:
24
+
25
+ - **Codex** ships a native plugin (`.codex-plugin/`), so it's a one-command
26
+ install like Claude Code. **OpenCode** has no marketplace command for
27
+ `SKILL.md` skills (its plugin system is npm JS plugins), so it relies on
28
+ skills-directory auto-discovery or a symlink.
29
+ - A **shared skills directory** can serve two agents: `~/.agents/skills/`
30
+ is read by Codex and OpenCode; `~/.claude/skills/` by Claude Code and
31
+ OpenCode.
32
+ - The scaffolded output needs no porting on any of them — it is read
33
+ natively wherever `AGENTS.md` is the instruction file.
34
+
35
+ See the [README](README.md#install) for the full matrix, Windows paths,
36
+ and local-development options.
37
+
38
+ ## 1. Triggering the skills
39
+
40
+ Once docflow is installed (per the table above), the skills are available
41
+ in any repo. Invocation differs per agent:
42
+
43
+ | Agent | Slash / mention | Auto-trigger from description |
44
+ |-------|-----------------|-------------------------------|
45
+ | Claude Code / Cowork | `/bootstrap`, `/new-adr`, … | yes |
46
+ | pi | `/skill:bootstrap`, `/skill:new-adr`, … | no — invoke explicitly |
47
+ | Codex | `$bootstrap` / `/skills` | yes |
48
+ | OpenCode | (loaded by name) | yes, by description |
49
+
50
+ On agents that **auto-trigger**, natural-language matching the skill's
51
+ description also works, e.g.:
52
+
53
+ - "set up documentation-led conventions in this repo"
54
+ - "bootstrap ADRs and a plan queue"
55
+ - "scaffold AGENTS.md and the _agent/ layout"
56
+ - "retrofit this existing repo with the documentation conventions"
57
+
58
+ Or, on any agent, name the skill explicitly: *"invoke the `bootstrap`
59
+ skill on this repository."*
23
60
 
24
61
  ## 2. The flow
25
62
 
@@ -164,12 +201,33 @@ The repo is now ready for ADR-driven work. Typical first steps:
164
201
  ## 5a. Lifecycle skills
165
202
 
166
203
  The manual workflow in §5 is exactly what the lifecycle skills
167
- automate. They all share three properties: they **read `CONVENTIONS.md`
168
- first** and honour the repo's recorded choices (ADR shape, status
169
- lifecycle, integration model, multi-agent mode); they **refuse on an
170
- un-bootstrapped repo** and point at `/bootstrap`; and they keep
171
- `INDEX.md` and the `_agent/` coordination files in sync as a side
172
- effect.
204
+ automate. They all share four properties: they **run a short assessment
205
+ first** (see below); they **read `CONVENTIONS.md` first** and honour the
206
+ repo's recorded choices (ADR shape, status lifecycle, integration model,
207
+ multi-agent mode); they **refuse on an un-bootstrapped repo** and point
208
+ at `/bootstrap`; and they keep `INDEX.md` and the `_agent/` coordination
209
+ files in sync as a side effect.
210
+
211
+ **The assessment protocol.** `new-adr`, `new-plan`, `add-convention`,
212
+ `brainstorm`, and `agent-wave` each open with a brief assessment before
213
+ acting — the same pattern bootstrap uses (§3):
214
+
215
+ - An **opt-out gate** first: *run the assessment, or skip it?* The
216
+ recommended default flips on context — *run* when you invoked the skill
217
+ with little detail, *skip* when your request already specifies
218
+ everything.
219
+ - Questions are asked **one at a time**, each with a **recommended
220
+ option** you can accept, override, or replace.
221
+ - Answers use **scroll-to-select** (single- or multiple-choice) where the
222
+ host exposes a selection tool (Claude Code's `AskUserQuestion`), falling
223
+ back to plain `A/B/C` lists otherwise. Free text is used only where an
224
+ enumerable set is impossible (e.g. an ADR title).
225
+ - **You decide** — a skill never proceeds past a question without your
226
+ input, and never guesses scope when invoked with no context.
227
+
228
+ `agent-wave` additionally asks the wave parallelism and the merge /
229
+ integration strategy. So a bare *"new ADR"* leads with a couple of quick
230
+ picks; a fully-specified request lets you skip straight through.
173
231
 
174
232
  | Skill | Replaces these manual steps |
175
233
  |-------|------------------------------|
@@ -319,6 +377,16 @@ To remove the plugin entirely:
319
377
  /plugin uninstall docflow@evolvehq
320
378
  ```
321
379
 
380
+ **Other agents:**
381
+
382
+ - **Cowork** — same as Claude Code (`/plugin marketplace update` →
383
+ install).
384
+ - **pi** — re-run `pi install npm:@evolvehq/docflow` (or the `git:` form).
385
+ - **Codex** — `codex plugin marketplace upgrade` then `codex plugin
386
+ install docflow`.
387
+ - **OpenCode** — if installed via a clone/symlink, `git pull` the clone;
388
+ skills reload on the next session.
389
+
322
390
  ### As the author (you, maintaining this repo)
323
391
 
324
392
  1. Edit a skill body (`skills/<name>/SKILL.md`), the bootstrap templates
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@evolvehq/docflow",
3
- "version": "0.6.0",
3
+ "version": "0.7.1",
4
4
  "description": "ADR-driven documentation workflow: scaffold an Architecture Decision Record (ADR) catalogue, a plan/ queue, and AGENTS.md conventions into any repo, then author, queue, ship, and audit ADRs with lifecycle skills. Works with the pi coding agent and Claude Code.",
5
5
  "keywords": [
6
6
  "pi-package",