create-harness-vibe-coding 0.8.6 → 0.8.8
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/README-CN.md +157 -105
- package/README.md +160 -244
- package/bin/create-harness-vibe-coding.js +2 -2
- package/docs/images/harness-architecture-light.png +0 -0
- package/docs/images/harness-architecture.drawio +164 -0
- package/package.json +46 -44
- package/src/generator.js +30 -11
- package/src/index.js +143 -14
- package/src/prompts.js +37 -37
- package/templates/common/.claude/agents/architect-manager.md +45 -45
- package/templates/common/.claude/agents/context-master.md +75 -75
- package/templates/common/.claude/agents/debugger.md +41 -41
- package/templates/common/.claude/agents/explore-manager.md +41 -41
- package/templates/common/.claude/agents/implement-manager.md +49 -49
- package/templates/common/.claude/agents/implementer.md +40 -40
- package/templates/common/.claude/agents/memory-master.md +64 -64
- package/templates/common/.claude/agents/planner.md +34 -34
- package/templates/common/.claude/agents/reflector.md +35 -0
- package/templates/common/.claude/agents/researcher.md +41 -41
- package/templates/common/.claude/agents/review-manager.md +56 -56
- package/templates/common/.claude/agents/verifier.md +34 -32
- package/templates/common/.claude/commands/wf-help.md +2 -3
- package/templates/common/.claude/rules/ecc/common.md +44 -44
- package/templates/common/.claude/skills/subagent-orchestrator/SKILL.md +10 -4
- package/templates/common/.claude/skills/wf/SKILL.md +7 -3
- package/templates/common/.claude/skills/wf-auto/SKILL.md +61 -107
- package/templates/common/.claude/skills/wf-auto-spark/SKILL.md +19 -17
- package/templates/common/.claude/skills/wf-max/SKILL.md +40 -21
- package/templates/common/.claude/skills/wf-readme/SKILL.md +49 -49
- package/templates/common/.claude/skills/wf-remove/SKILL.md +7 -7
- package/templates/common/.claude/skills/wf-update/SKILL.md +9 -4
- package/templates/common/.codex/config.toml +5 -0
- package/templates/common/.harness-version +78 -36
- package/templates/common/.opencode/agents/architect-manager.md +52 -0
- package/templates/common/.opencode/agents/architect.md +35 -0
- package/templates/common/.opencode/agents/context-master.md +81 -0
- package/templates/common/.opencode/agents/debugger.md +43 -0
- package/templates/common/.opencode/agents/docs-researcher.md +42 -0
- package/templates/common/.opencode/agents/explore-manager.md +49 -0
- package/templates/common/.opencode/agents/implement-manager.md +56 -0
- package/templates/common/.opencode/agents/implementer.md +42 -0
- package/templates/common/.opencode/agents/memory-master.md +70 -0
- package/templates/common/.opencode/agents/planner.md +38 -0
- package/templates/common/.opencode/agents/reflector.md +39 -0
- package/templates/common/.opencode/agents/researcher.md +42 -0
- package/templates/common/.opencode/agents/review-manager.md +63 -0
- package/templates/common/.opencode/agents/reviewer.md +37 -0
- package/templates/common/.opencode/agents/tdd-guide.md +83 -0
- package/templates/common/.opencode/agents/test-writer.md +54 -0
- package/templates/common/.opencode/agents/verifier.md +37 -0
- package/templates/common/.opencode/commands/wf-help.md +23 -0
- package/templates/common/AGENTS.md +26 -25
- package/templates/common/CLAUDE.md +86 -88
- package/templates/common/Harness/ACCEPTANCE_PROTOCOL.md +12 -4
- package/templates/common/Harness/PROGRESS.md +17 -17
- package/templates/common/Harness/README.md +26 -16
- package/templates/common/Harness/WF-AUTO-ANGLES.md +170 -0
- package/templates/common/Harness/WF-AUTO-SPARK.md +23 -6
- package/templates/common/Harness/WF-AUTO.md +508 -493
- package/templates/common/Harness/WF-MAX.md +284 -232
- package/templates/common/Harness/WF.md +47 -29
- package/templates/common/Harness/agent-workflow.md +108 -76
- package/templates/common/Harness/architecture.md +124 -124
- package/templates/common/Harness/context-loading.md +111 -111
- package/templates/common/Harness/dispatch.md +96 -95
- package/templates/common/Harness/extension.md +67 -67
- package/templates/common/Harness/lifecycle.md +20 -20
- package/templates/common/Harness/research/PRD.md +56 -56
- package/templates/common/Harness/research/README.md +169 -169
- package/templates/common/Harness/research/research-results.md +66 -66
- package/templates/common/Harness/subagents.md +192 -170
- package/templates/common/Harness/tasks/_template/ARTIFACTS.md +3 -3
- package/templates/common/Harness/tasks/_template/NOTES.md +3 -3
- package/templates/common/Harness/tasks/_template/PLAN.md +53 -60
- package/templates/common/Harness/tasks/_template/PROGRESS.md +26 -29
- package/templates/common/MEMORY.md +27 -30
- package/templates/common/README.md +36 -36
- package/templates/common/SETUP.md +1 -1
- package/templates/common/memory/agent-lessons-patterns.md +21 -21
- package/templates/common/memory/tool-usage-reflections.md +21 -21
- package/templates/common/memory/user-corrections-preferences.md +21 -21
- package/templates/common/opencode.json +19 -0
- package/templates/common/scripts/scan-clean.mjs +487 -448
- package/templates/common/scripts/validate-harness.mjs +245 -146
- package/templates/common/scripts/wf-remove.mjs +311 -293
- package/templates/common/scripts/wf-update-check.mjs +511 -311
- package/templates/optional/catalog.json +41 -33
- package/templates/optional/skills/browser-e2e/.claude/skills/wf-browser/SKILL.md +194 -194
- package/templates/optional/skills/browser-e2e/Harness/workflows/browser-e2e.md +105 -69
- package/templates/optional/skills/github-pr-review/Harness/workflows/github-pr-review.md +28 -28
- package/templates/optional/skills/python-backend/Harness/workflows/python-backend.md +34 -34
- package/templates/optional/skills/ts-react-frontend/Harness/workflows/ts-react-frontend.md +34 -34
- package/templates/optional/skills/ui-ux-review/Harness/workflows/ui-ux-review.md +26 -26
|
@@ -1,107 +1,61 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: wf-auto
|
|
3
|
-
description: Perpetual auto-optimization mode.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# WF Auto
|
|
7
|
-
|
|
8
|
-
## Load
|
|
9
|
-
|
|
10
|
-
- `Harness/WF-AUTO.md`
|
|
11
|
-
- `Harness/
|
|
12
|
-
- `Harness/
|
|
13
|
-
- `Harness/
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
2.
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
| 5 | Competitor/Peer Projects | LOW |
|
|
63
|
-
| 6 | Real-world Issues | MEDIUM |
|
|
64
|
-
| 7 | Architecture Trends | LOW |
|
|
65
|
-
| 8 | Performance Benchmarks | MEDIUM |
|
|
66
|
-
|
|
67
|
-
Source-quality: official docs > blog posts. Trending ≠ correct. Competitor behavior is hypothesis only. Every spark MUST cite source with URL and date.
|
|
68
|
-
|
|
69
|
-
## Perpetual Loop
|
|
70
|
-
|
|
71
|
-
```
|
|
72
|
-
W0: SENSE (8 angles + oracle + 8 spark sources, all parallel)
|
|
73
|
-
A-GATE [findings? → W1 | all empty? → oracle → spark → confirm ×2 → STOP]
|
|
74
|
-
CHECKPOINT [every 2→5→10 cycles, 2 questions]
|
|
75
|
-
W1: PRIORITIZE (across internal + oracle + spark)
|
|
76
|
-
W2: IMPLEMENT → W3: REVIEW → W4: DEBUG → W5: VERIFY
|
|
77
|
-
RECORD + EVIDENCE LEDGER → LOOP W0
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
## Cycle Recording
|
|
81
|
-
|
|
82
|
-
Every cycle writes to `Harness/tasks/auto/PROGRESS.md`:
|
|
83
|
-
- Cycle number, timestamp, state
|
|
84
|
-
- Source (internal/oracle/spark-*), source citation
|
|
85
|
-
- Finding, change description, files changed
|
|
86
|
-
- Value Gate scores (if spark candidate)
|
|
87
|
-
- Review result, verification evidence
|
|
88
|
-
- Evidence Ledger: evidence type, expected impact, verification method, measured result, verdict
|
|
89
|
-
|
|
90
|
-
## Safety
|
|
91
|
-
|
|
92
|
-
- ≤3 files, ≤50 lines per cycle
|
|
93
|
-
- Big ideas (>50 lines) escalate to /wf or /wf-max, then return to auto
|
|
94
|
-
- Destructive changes flagged with rollback plan
|
|
95
|
-
- IDLE alarm after 5 empty cycles → re-scope → A-GATE candidate
|
|
96
|
-
- Spark stop: 5 failed Value Gates OR 3 weak measured impacts OR 2 repeated source families empty
|
|
97
|
-
- User can interrupt at any time
|
|
98
|
-
|
|
99
|
-
## Return Format
|
|
100
|
-
|
|
101
|
-
- Total cycles run
|
|
102
|
-
- Findings addressed per source (internal / oracle / spark)
|
|
103
|
-
- Evidence ledger with measured impacts
|
|
104
|
-
- Exhaustion evidence (3-round confirmation)
|
|
105
|
-
- Weak spark count
|
|
106
|
-
- Final codebase state
|
|
107
|
-
- Residual risk assessment
|
|
1
|
+
---
|
|
2
|
+
name: wf-auto
|
|
3
|
+
description: Perpetual adaptive auto-optimization mode. Selects probes from project evidence instead of a fixed angle count. Inherits WF acceptance gates and subagent orchestration per cycle. Use for Claude /wf-auto, Codex $wf-auto, auto mode, or unbounded self-directed optimization.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# WF Auto - Perpetual Auto-Optimization
|
|
7
|
+
|
|
8
|
+
## Load
|
|
9
|
+
|
|
10
|
+
- `Harness/WF-AUTO.md`
|
|
11
|
+
- `Harness/WF-AUTO-ANGLES.md`
|
|
12
|
+
- `Harness/subagents.md`
|
|
13
|
+
- `Harness/dispatch.md`
|
|
14
|
+
- `Harness/agent-workflow.md`
|
|
15
|
+
- `.claude/skills/wf-review/SKILL.md`
|
|
16
|
+
|
|
17
|
+
## Trigger
|
|
18
|
+
|
|
19
|
+
- Claude `/wf-auto`
|
|
20
|
+
- Codex `$wf-auto`
|
|
21
|
+
- `wf auto`, `auto mode`, or a request for continuous self-directed improvement
|
|
22
|
+
|
|
23
|
+
Do not use when the user gives a bounded task, requests maximum parallelism
|
|
24
|
+
(`/wf-max`), needs an urgent production hotfix, or the codebase is tiny enough
|
|
25
|
+
that auto scanning costs more than it helps.
|
|
26
|
+
|
|
27
|
+
## Hard Rules
|
|
28
|
+
|
|
29
|
+
1. Never stop except the Adaptive Coverage A-GATE: dynamic high-risk
|
|
30
|
+
obligations are covered, two different confirmation strategies are empty,
|
|
31
|
+
and unresolved uncertainty is recorded.
|
|
32
|
+
2. CEO never edits production source. CEO may write only
|
|
33
|
+
`Harness/tasks/auto/PLAN.md` and `Harness/tasks/auto/PROGRESS.md`.
|
|
34
|
+
3. Build a project profile each W0 cycle and dispatch only the selected probes;
|
|
35
|
+
invoke oracle and spark searchers when evidence justifies them.
|
|
36
|
+
4. One accepted finding per cycle: <=3 files and <=50 changed lines. Larger
|
|
37
|
+
ideas escalate to `/wf` or `/wf-max`, then return to auto.
|
|
38
|
+
5. Every accepted cycle inherits the full WF chain:
|
|
39
|
+
`Mini PRD -> AC IDs -> test/validation plan -> implementer -> verifier ->
|
|
40
|
+
cross-review -> reflector PASS -> evidence ledger -> next W0`.
|
|
41
|
+
6. Review is mandatory: spec review, code-quality review, then reflector.
|
|
42
|
+
7. Value Gate is scored for spark candidates: pass is >=18/25 and no dimension
|
|
43
|
+
below 3.
|
|
44
|
+
8. Intent Checkpoint is adaptive: 2 -> 5 -> 10 cycles, exactly two questions.
|
|
45
|
+
9. Record compact evidence per cycle; do not paste full logs or transcripts.
|
|
46
|
+
|
|
47
|
+
## Loop
|
|
48
|
+
|
|
49
|
+
```text
|
|
50
|
+
W0: SENSE (adaptive probes + oracle + spark sources as triggered)
|
|
51
|
+
A-GATE: continue, oracle, spark, confirm, or stop
|
|
52
|
+
W1: PRIORITIZE one finding
|
|
53
|
+
W2-W5: Mini PRD -> AC -> test/validation plan -> implementer -> verifier -> cross-review -> reflector PASS
|
|
54
|
+
RECORD: evidence ledger
|
|
55
|
+
LOOP: next W0
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Return
|
|
59
|
+
|
|
60
|
+
Report cycles run, findings addressed by source, evidence ledger, exhaustion
|
|
61
|
+
evidence if any, weak spark count, final state, and residual risks.
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: wf-auto-spark
|
|
3
|
-
description:
|
|
3
|
+
description: Perpetual inspiration mode for /wf-auto-spark or $wf-auto-spark. Inherits WF-AUTO/WF execution gates while using external spark search, roadmap anchoring, and <=50% deviation guard.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# WF-AUTO-SPARK Adapter
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
The authoritative workflow lives in `Harness/WF-AUTO-SPARK.md`; this adapter
|
|
9
|
+
only routes and summarizes hard constraints.
|
|
10
10
|
|
|
11
11
|
## Invocation
|
|
12
12
|
|
|
13
|
-
- Claude Code:
|
|
14
|
-
- Codex
|
|
13
|
+
- Claude Code: `/wf-auto-spark`
|
|
14
|
+
- Codex: `$wf-auto-spark` or `/skills` then choose `wf-auto-spark`
|
|
15
15
|
|
|
16
16
|
## Load
|
|
17
17
|
|
|
@@ -25,15 +25,17 @@ This skill is a thin tool adapter. The authoritative workflow lives in
|
|
|
25
25
|
|
|
26
26
|
## Rules
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
28
|
+
1. Roadmap first: declare North Star and staged milestones before spark cycles.
|
|
29
|
+
2. Never auto-stop: only the user can stop; "no sparks found" expands search.
|
|
30
|
+
3. Spark replaces discovery only. Accepted candidates still run:
|
|
31
|
+
`Mini PRD -> AC IDs -> test/validation plan -> implementer -> verifier ->
|
|
32
|
+
cross-review -> reflector PASS -> evidence ledger`.
|
|
33
|
+
4. Spark searchers are read-only. Implementation requires explicit dispatch
|
|
34
|
+
packet, write set, forbidden truth files, AC IDs, and verification commands.
|
|
35
|
+
5. Deviation guard: each spark must align >=50% with North Star; rolling
|
|
36
|
+
10-cycle average below 65% forces Re-Anchor Gate.
|
|
37
|
+
6. Value reflection is required every cycle: source, why it matters, deviation,
|
|
38
|
+
evidence, and milestone progress.
|
|
39
|
+
|
|
40
|
+
Active roadmap: `Harness/tasks/auto/SPARK-ROADMAP.md`.
|
|
41
|
+
Per-cycle evidence: `Harness/tasks/auto/PROGRESS.md`.
|
|
@@ -1,18 +1,17 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: wf-max
|
|
3
|
-
description: Use for /wf-max in Claude Code, $wf-max or /skills wf-max in Codex, or maximum-parallelism Harness work with CEO
|
|
3
|
+
description: Use for /wf-max in Claude Code, $wf-max or /skills wf-max in Codex, or maximum-parallelism Harness work with WF strict-superset gates and CEO -> manager -> worker decomposition.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# WF-MAX Adapter
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
8
|
+
The authoritative workflow lives in `Harness/WF-MAX.md`; this adapter only
|
|
9
|
+
routes and summarizes hard constraints.
|
|
10
10
|
|
|
11
11
|
## Invocation
|
|
12
12
|
|
|
13
|
-
- Claude Code:
|
|
14
|
-
- Codex
|
|
15
|
-
- Codex app may also list enabled skills in the `/` menu.
|
|
13
|
+
- Claude Code: `/wf-max [task]`
|
|
14
|
+
- Codex: `$wf-max` or `/skills` then choose `wf-max`
|
|
16
15
|
|
|
17
16
|
## Load
|
|
18
17
|
|
|
@@ -26,18 +25,38 @@ This skill is a thin tool adapter. The authoritative workflow lives in
|
|
|
26
25
|
|
|
27
26
|
## Rules
|
|
28
27
|
|
|
29
|
-
WF-MAX is a
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
-
|
|
37
|
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
28
|
+
WF-MAX is a WF strict superset: every WF role, gate, and acceptance rule still
|
|
29
|
+
applies, then execution expands through:
|
|
30
|
+
|
|
31
|
+
1. Global mode: `wf-max`
|
|
32
|
+
2. Agent role: `ceo | manager | worker | reviewer | verifier | reflector`
|
|
33
|
+
3. Dispatch permission: `writeSet`, `forbidden`, `verification`
|
|
34
|
+
|
|
35
|
+
- CEO reads, plans, dispatches, synthesizes, and writes task state only. CEO
|
|
36
|
+
never edits production source.
|
|
37
|
+
- Workers edit only the dispatch `writeSet`; outside write set is blocked.
|
|
38
|
+
- Managers coordinate and synthesize. Reviewers read/report only.
|
|
39
|
+
- D-GATE is mandatory before implementation waves: dispatch table, AC IDs,
|
|
40
|
+
disjoint file claims, self-audit, and reviewer plan.
|
|
41
|
+
- Final acceptance requires verifier evidence, cross-review, and reflector PASS.
|
|
42
|
+
|
|
43
|
+
## Fan-Out Discipline
|
|
44
|
+
|
|
45
|
+
- Use as many useful subagents as the runtime safely allows.
|
|
46
|
+
- Codex capacity may be configured through official `agents.max_threads` and
|
|
47
|
+
`agents.max_depth`; generated Harness config defaults to
|
|
48
|
+
`.codex/config.toml` with `max_threads = 12` and `max_depth = 1`.
|
|
49
|
+
- Close completed agents before declaring the pool exhausted.
|
|
50
|
+
- If Codex remains bottlenecked, ask the user before raising
|
|
51
|
+
`agents.max_threads` above the scaffold default. Do not silently edit project
|
|
52
|
+
or global Codex config.
|
|
53
|
+
- Keep `agents.max_depth = 1` unless the user explicitly approves recursive
|
|
54
|
+
delegation.
|
|
55
|
+
- If the current runtime is exhausted, overflow to the other CLI with explicit
|
|
56
|
+
dispatch packets: Codex -> `claude -p`; Claude -> available Codex CLI such as
|
|
57
|
+
`codex exec`.
|
|
58
|
+
- Do not rely on undocumented config, environment variables, forked/derived
|
|
59
|
+
conversations, Codex++, local patches, or third-party forks as stable ways to
|
|
60
|
+
remove subagent limits.
|
|
61
|
+
- Fall back to bounded role passes only when native subagents and cross-CLI
|
|
62
|
+
overflow are unavailable; record the fallback in the task PLAN.
|
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: wf-readme
|
|
3
|
-
description: Use when a project README already exists and the user asks to preserve, merge, modernize, optimize, or clarify repository documentation during harness install or documentation work.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# README Optimizer
|
|
7
|
-
|
|
8
|
-
Improve `README.md` without breaking project-owned public docs.
|
|
9
|
-
|
|
10
|
-
## Load
|
|
11
|
-
|
|
12
|
-
- root `README.md`
|
|
13
|
-
- package files and scripts (`package.json`, `pyproject.toml`, `go.mod`, etc.)
|
|
14
|
-
- CI files when present
|
|
15
|
-
- `Harness/PROGRESS.md`
|
|
16
|
-
- `Harness/tasks/<task-id>/PLAN.md` when available
|
|
17
|
-
- `Harness/architecture.md` only when an architecture summary or diagram is requested
|
|
18
|
-
|
|
19
|
-
## Mode
|
|
20
|
-
|
|
21
|
-
Ask the user which mode they approve when the existing README is meaningful:
|
|
22
|
-
|
|
23
|
-
| Mode | Use when | Allowed edit |
|
|
24
|
-
| --- | --- | --- |
|
|
25
|
-
| Preserve + append | default for existing projects | Add only a compact Development, Test, Build, Git, or Harness section |
|
|
26
|
-
| Structure pass | README is stale, hard to scan, or missing operational docs | Reorganize with headings, tables, command blocks, and links while preserving facts |
|
|
27
|
-
| Full rewrite | user explicitly wants a polished public README | Rewrite after approval; keep claims source-backed |
|
|
28
|
-
|
|
29
|
-
If unanswered, use Preserve + append.
|
|
30
|
-
|
|
31
|
-
## Rules
|
|
32
|
-
|
|
33
|
-
- Preserve existing product, package, API, and public-facing content unless the user approves a rewrite.
|
|
34
|
-
- Do not invent features, benchmarks, roadmap, support policy, badges, install commands, or CI status.
|
|
35
|
-
- Use tables for command matrices, environment variables, endpoints, and deployment notes when facts are known.
|
|
36
|
-
- Use Mermaid or ASCII architecture diagrams only when the structure is observed or approved; label uncertain diagrams as proposed.
|
|
37
|
-
- Keep detailed architecture in `Harness/architecture.md`; README may link to it or show a short overview.
|
|
38
|
-
- Keep agent rules in `CLAUDE.md`/`AGENTS.md`, not README.
|
|
39
|
-
- Record the chosen mode and any skipped README improvements in `Harness/tasks/<task-id>/PLAN.md` when available.
|
|
40
|
-
|
|
41
|
-
## Output
|
|
42
|
-
|
|
43
|
-
Before broad edits, return:
|
|
44
|
-
|
|
45
|
-
1. chosen mode
|
|
46
|
-
2. sections to preserve
|
|
47
|
-
3. sections to add or reorganize
|
|
48
|
-
4. facts still unknown
|
|
49
|
-
5. verification command or manual review step
|
|
1
|
+
---
|
|
2
|
+
name: wf-readme
|
|
3
|
+
description: Use when a project README already exists and the user asks to preserve, merge, modernize, optimize, or clarify repository documentation during harness install or documentation work.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# README Optimizer
|
|
7
|
+
|
|
8
|
+
Improve `README.md` without breaking project-owned public docs.
|
|
9
|
+
|
|
10
|
+
## Load
|
|
11
|
+
|
|
12
|
+
- root `README.md`
|
|
13
|
+
- package files and scripts (`package.json`, `pyproject.toml`, `go.mod`, etc.)
|
|
14
|
+
- CI files when present
|
|
15
|
+
- `Harness/PROGRESS.md`
|
|
16
|
+
- `Harness/tasks/<task-id>/PLAN.md` when available
|
|
17
|
+
- `Harness/architecture.md` only when an architecture summary or diagram is requested
|
|
18
|
+
|
|
19
|
+
## Mode
|
|
20
|
+
|
|
21
|
+
Ask the user which mode they approve when the existing README is meaningful:
|
|
22
|
+
|
|
23
|
+
| Mode | Use when | Allowed edit |
|
|
24
|
+
| --- | --- | --- |
|
|
25
|
+
| Preserve + append | default for existing projects | Add only a compact Development, Test, Build, Git, or Harness section |
|
|
26
|
+
| Structure pass | README is stale, hard to scan, or missing operational docs | Reorganize with headings, tables, command blocks, and links while preserving facts |
|
|
27
|
+
| Full rewrite | user explicitly wants a polished public README | Rewrite after approval; keep claims source-backed |
|
|
28
|
+
|
|
29
|
+
If unanswered, use Preserve + append.
|
|
30
|
+
|
|
31
|
+
## Rules
|
|
32
|
+
|
|
33
|
+
- Preserve existing product, package, API, and public-facing content unless the user approves a rewrite.
|
|
34
|
+
- Do not invent features, benchmarks, roadmap, support policy, badges, install commands, or CI status.
|
|
35
|
+
- Use tables for command matrices, environment variables, endpoints, and deployment notes when facts are known.
|
|
36
|
+
- Use Mermaid or ASCII architecture diagrams only when the structure is observed or approved; label uncertain diagrams as proposed.
|
|
37
|
+
- Keep detailed architecture in `Harness/architecture.md`; README may link to it or show a short overview.
|
|
38
|
+
- Keep agent rules in `CLAUDE.md`/`AGENTS.md`, not README.
|
|
39
|
+
- Record the chosen mode and any skipped README improvements in `Harness/tasks/<task-id>/PLAN.md` when available.
|
|
40
|
+
|
|
41
|
+
## Output
|
|
42
|
+
|
|
43
|
+
Before broad edits, return:
|
|
44
|
+
|
|
45
|
+
1. chosen mode
|
|
46
|
+
2. sections to preserve
|
|
47
|
+
3. sections to add or reorganize
|
|
48
|
+
4. facts still unknown
|
|
49
|
+
5. verification command or manual review step
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: wf-remove
|
|
3
|
-
description: Use for /wf-remove in Claude Code, $wf-remove or /skills wf-remove in Codex, or any request to uninstall Harness safely.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# WF Remove Adapter
|
|
7
|
-
|
|
1
|
+
---
|
|
2
|
+
name: wf-remove
|
|
3
|
+
description: Use for /wf-remove in Claude Code, $wf-remove or /skills wf-remove in Codex, or any request to uninstall Harness safely.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# WF Remove Adapter
|
|
7
|
+
|
|
8
8
|
## Invocation
|
|
9
9
|
|
|
10
10
|
- Claude Code: use `/wf-remove` or select the `wf-remove` skill.
|
|
@@ -23,13 +23,18 @@ description: Use for /wf-update in Claude Code, $wf-update or /skills wf-update
|
|
|
23
23
|
`agent` block as the action plan.
|
|
24
24
|
2. Preserve all PRESERVE files. Never overwrite user task, memory, research,
|
|
25
25
|
README, package, or architecture files.
|
|
26
|
-
3. If `agent.safeApplyCommand` is present, run it to apply SAFE
|
|
27
|
-
before spending AI time on conflicts. Default command:
|
|
26
|
+
3. If `agent.safeApplyCommand` is present, run it to apply SAFE, NEW, and
|
|
27
|
+
adopted metadata-only files before spending AI time on conflicts. Default command:
|
|
28
28
|
`node Harness/scripts/wf-update-check.mjs --apply-safe`.
|
|
29
29
|
4. For every `agent.aiMergeRequired` entry, compare the local file with
|
|
30
30
|
`templateHint` or `remoteUrl`, then choose merge, keep-local, or
|
|
31
|
-
overwrite-from-template.
|
|
32
|
-
|
|
31
|
+
overwrite-from-template. Record the decision through the script with
|
|
32
|
+
`--accept-local <file>`, `--accept-merged <file>`, or
|
|
33
|
+
`--accept-template <file>`; do not hand-edit `Harness/.harness-version`.
|
|
34
|
+
Ask the user only when the intent is ambiguous.
|
|
35
|
+
5. Run `node Harness/scripts/wf-update-check.mjs --finalize` after all
|
|
36
|
+
conflicts have script-recorded decisions. Use strict `--apply` only when the
|
|
37
|
+
JSON plan has zero conflicts.
|
|
33
38
|
6. After update, run the validator and then scan-clean.
|
|
34
39
|
|
|
35
40
|
## Return
|