compound-workflow 1.6.1 → 1.6.2
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/.claude-plugin/plugin.json +1 -1
- package/.cursor-plugin/plugin.json +1 -1
- package/README.md +25 -6
- package/package.json +1 -1
- package/scripts/install-cli.mjs +5 -4
- package/scripts/postinstall.mjs +1 -1
package/README.md
CHANGED
|
@@ -24,18 +24,37 @@ flowchart LR
|
|
|
24
24
|
|
|
25
25
|
## Get Started
|
|
26
26
|
|
|
27
|
+
**1. Install the package**
|
|
28
|
+
|
|
27
29
|
```bash
|
|
28
30
|
npm install compound-workflow
|
|
29
31
|
```
|
|
30
32
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
+
**2. Automatic setup**
|
|
34
|
+
|
|
35
|
+
The package’s `postinstall` script runs and configures your repo: `AGENTS.md`, standard directories, and OpenCode wiring. No separate npx step is needed.
|
|
36
|
+
|
|
37
|
+
**3. If lifecycle scripts were skipped**
|
|
38
|
+
|
|
39
|
+
If your package manager didn’t run postinstall, run once:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx compound-workflow install
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**4. After updating the package**
|
|
46
|
+
|
|
47
|
+
To get the latest commands and wiring (e.g. after `npm update compound-workflow` or a new release), run install again so your project’s `opencode.json` is refreshed:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npx compound-workflow install
|
|
51
|
+
```
|
|
33
52
|
|
|
34
|
-
|
|
53
|
+
**What gets configured**
|
|
35
54
|
|
|
36
|
-
- Workflow template
|
|
37
|
-
- Standard workspace directories
|
|
38
|
-
- `opencode.json` managed entries
|
|
55
|
+
- Workflow template in `AGENTS.md`
|
|
56
|
+
- Standard workspace directories (plans, todos, docs)
|
|
57
|
+
- `opencode.json` managed entries pointing at `node_modules/compound-workflow/src/.agents/*`
|
|
39
58
|
|
|
40
59
|
## Breaking Change (2.0.0)
|
|
41
60
|
|
package/package.json
CHANGED
package/scripts/install-cli.mjs
CHANGED
|
@@ -14,11 +14,11 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
|
14
14
|
function usage(exitCode = 0) {
|
|
15
15
|
const msg = `
|
|
16
16
|
Usage:
|
|
17
|
-
|
|
17
|
+
(automatic) npm install compound-workflow # runs install via postinstall; no npx needed
|
|
18
|
+
(manual) npx compound-workflow install [--root <projectDir>] [--dry-run] [--no-config]
|
|
18
19
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
(unless --no-config).
|
|
20
|
+
Install writes opencode.json (from package), merges AGENTS.md, creates standard
|
|
21
|
+
docs/todos directories, and prompts for Repo Config Block (unless --no-config).
|
|
22
22
|
|
|
23
23
|
--root <dir> Project directory (default: cwd)
|
|
24
24
|
--dry-run Print planned changes only
|
|
@@ -366,6 +366,7 @@ function main() {
|
|
|
366
366
|
|
|
367
367
|
const genScript = path.join(PACKAGE_ROOT, "scripts", "generate-platform-artifacts.mjs");
|
|
368
368
|
if (fs.existsSync(genScript)) {
|
|
369
|
+
console.log("[compound-workflow] Regenerating manifest from package source...");
|
|
369
370
|
const result = spawnSync(process.execPath, [genScript], {
|
|
370
371
|
cwd: PACKAGE_ROOT,
|
|
371
372
|
stdio: "pipe",
|
package/scripts/postinstall.mjs
CHANGED
|
@@ -57,7 +57,7 @@ function run() {
|
|
|
57
57
|
|
|
58
58
|
if (result.status !== 0) {
|
|
59
59
|
console.warn(
|
|
60
|
-
"[compound-workflow] automatic setup failed; run `npx compound-workflow install` in your project."
|
|
60
|
+
"[compound-workflow] automatic setup failed; re-run `npm install compound-workflow` or run `npx compound-workflow install` in your project."
|
|
61
61
|
);
|
|
62
62
|
}
|
|
63
63
|
}
|