@evolvehq/docflow 0.7.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 +33 -23
  2. package/USAGE.md +62 -15
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -78,12 +78,11 @@ read natively by any agent that loads `AGENTS.md`; the **skills** are
78
78
  | Claude Code | native | ✅ | marketplace (below) | `/bootstrap` |
79
79
  | Claude Cowork | native | ✅ | same Claude Code plugin | `/bootstrap` |
80
80
  | pi | native | ✅ | `pi install npm:@evolvehq/docflow` | `/skill:bootstrap` |
81
- | Codex | native | ✅ | copy into `~/.agents/skills/` | `$bootstrap` / `/skills` |
82
- | OpenCode | native | ✅ | reads `.claude`/`.agents`/`.opencode` skills | auto, by description |
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
83
 
84
- Handy: `~/.agents/skills/` is read by **both Codex and OpenCode**, and
85
- `~/.claude/skills/` by **both Claude Code and OpenCode** so one install
86
- often serves two agents.
84
+ Handy: OpenCode also reads `~/.claude/skills/` and `~/.agents/skills/`, so
85
+ a shared skills directory can serve it alongside another agent.
87
86
 
88
87
  ### Claude Code — from this marketplace
89
88
 
@@ -121,29 +120,36 @@ hierarchical `AGENTS.md` loading — no porting needed.
121
120
 
122
121
  ### Codex (OpenAI)
123
122
 
124
- Codex reads `AGENTS.md` natively and discovers skills from `.agents/skills`.
125
- Copy docflow's skills into a path Codex scans:
123
+ docflow ships a Codex plugin (`.codex-plugin/`), so it's a one-command
124
+ install from this repo's marketplace:
126
125
 
127
126
  ```
128
- # user-wide (all projects), from a clone of this repo:
129
- mkdir -p ~/.agents/skills && cp -r <docflow>/skills/* ~/.agents/skills/
130
- # or from npm:
131
- npm install @evolvehq/docflow
132
- cp -r node_modules/@evolvehq/docflow/skills/* ~/.agents/skills/
127
+ codex plugin marketplace add EvolveHQ/docflow
128
+ codex plugin install docflow
133
129
  ```
134
130
 
135
- On Windows, copy `skills\*` into `%USERPROFILE%\.agents\skills\`. Invoke
136
- with `$bootstrap` / `/skills`, or just describe the task (Codex
137
- auto-triggers from the skill description). The structured assessment
138
- questions fall back to plain `A/B/C` text where there is no select tool.
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`.
139
136
 
140
137
  ### OpenCode (sst)
141
138
 
142
- OpenCode scans `.opencode/skills/`, **`.claude/skills/`, and
143
- `.agents/skills/`** (project and global), so a Claude Code or Codex
144
- install is **picked up automatically** or copy `skills/*` into
145
- `~/.config/opencode/skills/` (or per-project `.opencode/skills/`). Skills
146
- auto-load by description.
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.
147
153
 
148
154
  ### Claude Code — local development (no install)
149
155
 
@@ -209,10 +215,14 @@ to extend or override the templates.
209
215
  ```
210
216
  docflow/
211
217
  .claude-plugin/
212
- plugin.json # Claude Code plugin manifest
218
+ plugin.json # Claude Code / Cowork plugin manifest
213
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
214
224
  package.json # pi package manifest (pi.skills -> ./skills) + npm metadata
215
- skills/
225
+ skills/ # the one skill source, shared by every target
216
226
  bootstrap/
217
227
  SKILL.md # bootstrap: assessment + output sequence + backfill
218
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
 
@@ -340,6 +377,16 @@ To remove the plugin entirely:
340
377
  /plugin uninstall docflow@evolvehq
341
378
  ```
342
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
+
343
390
  ### As the author (you, maintaining this repo)
344
391
 
345
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.7.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",