orchestr8 2.5.0 → 2.6.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.
- package/.blueprint/agents/AGENT_BA_CASS.md +42 -19
- package/.blueprint/agents/AGENT_DEVELOPER_CODEY.md +42 -38
- package/.blueprint/agents/AGENT_SPECIFICATION_ALEX.md +45 -0
- package/.blueprint/agents/AGENT_TESTER_NIGEL.md +42 -21
- package/.blueprint/features/feature_adaptive-retry/FEATURE_SPEC.md +239 -0
- package/.blueprint/features/feature_adaptive-retry/IMPLEMENTATION_PLAN.md +48 -0
- package/.blueprint/features/feature_adaptive-retry/story-prompt-modification.md +85 -0
- package/.blueprint/features/feature_adaptive-retry/story-retry-config.md +89 -0
- package/.blueprint/features/feature_adaptive-retry/story-should-retry.md +98 -0
- package/.blueprint/features/feature_adaptive-retry/story-strategy-recommendation.md +85 -0
- package/.blueprint/features/feature_agent-guardrails/FEATURE_SPEC.md +328 -0
- package/.blueprint/features/feature_agent-guardrails/IMPLEMENTATION_PLAN.md +90 -0
- package/.blueprint/features/feature_agent-guardrails/story-citation-requirements.md +50 -0
- package/.blueprint/features/feature_agent-guardrails/story-confidentiality.md +50 -0
- package/.blueprint/features/feature_agent-guardrails/story-escalation-protocol.md +55 -0
- package/.blueprint/features/feature_agent-guardrails/story-source-restrictions.md +50 -0
- package/.blueprint/features/feature_feedback-loop/FEATURE_SPEC.md +347 -0
- package/.blueprint/features/feature_feedback-loop/IMPLEMENTATION_PLAN.md +71 -0
- package/.blueprint/features/feature_feedback-loop/story-feedback-collection.md +63 -0
- package/.blueprint/features/feature_feedback-loop/story-feedback-config.md +61 -0
- package/.blueprint/features/feature_feedback-loop/story-feedback-insights.md +63 -0
- package/.blueprint/features/feature_feedback-loop/story-quality-gates.md +57 -0
- package/.blueprint/features/feature_pipeline-history/FEATURE_SPEC.md +239 -0
- package/.blueprint/features/feature_pipeline-history/IMPLEMENTATION_PLAN.md +71 -0
- package/.blueprint/features/feature_pipeline-history/story-clear-history.md +73 -0
- package/.blueprint/features/feature_pipeline-history/story-display-history.md +75 -0
- package/.blueprint/features/feature_pipeline-history/story-record-execution.md +76 -0
- package/.blueprint/features/feature_pipeline-history/story-show-statistics.md +85 -0
- package/.blueprint/features/feature_pipeline-insights/FEATURE_SPEC.md +288 -0
- package/.blueprint/features/feature_pipeline-insights/IMPLEMENTATION_PLAN.md +65 -0
- package/.blueprint/features/feature_pipeline-insights/story-anomaly-detection.md +71 -0
- package/.blueprint/features/feature_pipeline-insights/story-bottleneck-analysis.md +75 -0
- package/.blueprint/features/feature_pipeline-insights/story-failure-patterns.md +75 -0
- package/.blueprint/features/feature_pipeline-insights/story-json-output.md +75 -0
- package/.blueprint/features/feature_pipeline-insights/story-trend-analysis.md +78 -0
- package/.blueprint/features/feature_validate-command/FEATURE_SPEC.md +209 -0
- package/.blueprint/features/feature_validate-command/IMPLEMENTATION_PLAN.md +59 -0
- package/.blueprint/features/feature_validate-command/story-failure-output.md +61 -0
- package/.blueprint/features/feature_validate-command/story-node-version-check.md +52 -0
- package/.blueprint/features/feature_validate-command/story-run-validation.md +59 -0
- package/.blueprint/features/feature_validate-command/story-success-output.md +50 -0
- package/.blueprint/system_specification/SYSTEM_SPEC.md +248 -0
- package/README.md +182 -38
- package/SKILL.md +333 -23
- package/bin/cli.js +128 -20
- package/package.json +2 -2
- package/src/feedback.js +171 -0
- package/src/history.js +306 -0
- package/src/index.js +57 -2
- package/src/init.js +2 -6
- package/src/insights.js +504 -0
- package/src/retry.js +274 -0
- package/src/validate.js +172 -0
- package/src/skills.js +0 -93
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Story — Run Validation Command
|
|
2
|
+
|
|
3
|
+
## User story
|
|
4
|
+
As a developer, I want to run `orchestr8 validate` in my project directory so that I can check whether my environment is correctly configured before running the pipeline.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Context / scope
|
|
9
|
+
- Developer using orchestr8 CLI
|
|
10
|
+
- Command can be run in any directory (initialized or not)
|
|
11
|
+
- Route: `orchestr8 validate` via `bin/cli.js`
|
|
12
|
+
- This is the primary entry point for the validate feature
|
|
13
|
+
|
|
14
|
+
See feature spec: `.blueprint/features/feature_validate-command/FEATURE_SPEC.md`
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Acceptance criteria
|
|
19
|
+
|
|
20
|
+
**AC-1 — Command is available**
|
|
21
|
+
- Given I have orchestr8 installed,
|
|
22
|
+
- When I run `orchestr8 validate`,
|
|
23
|
+
- Then the command executes without throwing an exception.
|
|
24
|
+
|
|
25
|
+
**AC-2 — Checks execute in sequence**
|
|
26
|
+
- Given I run `orchestr8 validate`,
|
|
27
|
+
- When the command executes,
|
|
28
|
+
- Then all validation checks are performed:
|
|
29
|
+
- Directory existence (`.blueprint/`, `.business_context/`, `.claude/commands/`)
|
|
30
|
+
- System spec existence (`.blueprint/system_specification/SYSTEM_SPEC.md`)
|
|
31
|
+
- Agent spec files existence (4 files in `.blueprint/agents/`)
|
|
32
|
+
- Business context non-empty check
|
|
33
|
+
- Skills installed check (`.claude/commands/implement-feature.md`)
|
|
34
|
+
- Node.js version check (>=18)
|
|
35
|
+
|
|
36
|
+
**AC-3 — Each check produces a status line**
|
|
37
|
+
- Given I run `orchestr8 validate`,
|
|
38
|
+
- When each check completes,
|
|
39
|
+
- Then a status line is printed showing pass or fail for that check.
|
|
40
|
+
|
|
41
|
+
**AC-4 — Command completes without crashes**
|
|
42
|
+
- Given any combination of missing/present files,
|
|
43
|
+
- When I run `orchestr8 validate`,
|
|
44
|
+
- Then the command completes gracefully (does not throw exceptions)
|
|
45
|
+
- And all checks are wrapped to handle missing paths.
|
|
46
|
+
|
|
47
|
+
**AC-5 — Idempotent execution**
|
|
48
|
+
- Given I run `orchestr8 validate` multiple times,
|
|
49
|
+
- When each execution completes,
|
|
50
|
+
- Then no files are created, modified, or deleted
|
|
51
|
+
- And each run produces the same output for the same state.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Out of scope
|
|
56
|
+
- Validation of file contents (e.g., SYSTEM_SPEC.md is well-formed)
|
|
57
|
+
- Automatic remediation of issues
|
|
58
|
+
- Network checks
|
|
59
|
+
- Queue state validation
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Story — Validation Success Output
|
|
2
|
+
|
|
3
|
+
## User story
|
|
4
|
+
As a developer, I want to see clear success indicators when all validation checks pass so that I have confidence my project is ready to run the pipeline.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Context / scope
|
|
9
|
+
- Developer using orchestr8 CLI
|
|
10
|
+
- Project is fully initialized with all required artifacts
|
|
11
|
+
- This story covers the happy path output formatting
|
|
12
|
+
|
|
13
|
+
See feature spec: `.blueprint/features/feature_validate-command/FEATURE_SPEC.md`
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Acceptance criteria
|
|
18
|
+
|
|
19
|
+
**AC-1 — Checkmark displayed for passed checks**
|
|
20
|
+
- Given all required files and directories exist,
|
|
21
|
+
- When I run `orchestr8 validate`,
|
|
22
|
+
- Then each passed check displays a checkmark indicator.
|
|
23
|
+
|
|
24
|
+
**AC-2 — Colorized output when supported**
|
|
25
|
+
- Given my terminal supports color output,
|
|
26
|
+
- When I run `orchestr8 validate` and checks pass,
|
|
27
|
+
- Then checkmarks are displayed in green.
|
|
28
|
+
|
|
29
|
+
**AC-3 — ASCII fallback for non-color terminals**
|
|
30
|
+
- Given my terminal does not support color output,
|
|
31
|
+
- When I run `orchestr8 validate`,
|
|
32
|
+
- Then success indicators use ASCII-compatible characters
|
|
33
|
+
- And output remains readable.
|
|
34
|
+
|
|
35
|
+
**AC-4 — Overall success message**
|
|
36
|
+
- Given all validation checks pass,
|
|
37
|
+
- When the command completes,
|
|
38
|
+
- Then an overall success message is printed indicating the project is ready.
|
|
39
|
+
|
|
40
|
+
**AC-5 — Exit code zero on success**
|
|
41
|
+
- Given all validation checks pass,
|
|
42
|
+
- When the command completes,
|
|
43
|
+
- Then the process exits with code 0
|
|
44
|
+
- And this exit code can be used in scripts/CI pipelines.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Out of scope
|
|
49
|
+
- JSON output format (deferred)
|
|
50
|
+
- Verbose mode with additional details
|
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
# System Specification — orchestr8
|
|
2
|
+
|
|
3
|
+
## 1. Purpose & Intent
|
|
4
|
+
|
|
5
|
+
**orchestr8** is a multi-agent workflow framework that automates feature development from specification to implementation. It coordinates four specialized AI agents (Alex, Cass, Nigel, Codey) through a sequential pipeline, ensuring that features are explicitly specified, documented with user stories, tested, and implemented with traceability.
|
|
6
|
+
|
|
7
|
+
**Why this system exists:**
|
|
8
|
+
- To transform feature ideas into working, tested code through a structured, repeatable process
|
|
9
|
+
- To maintain coherence between specifications, stories, tests, and implementation
|
|
10
|
+
- To reduce ambiguity and drift by enforcing explicit handoffs between agents
|
|
11
|
+
|
|
12
|
+
**Who it exists for:**
|
|
13
|
+
- Developers using Claude Code who want automated, spec-driven feature development
|
|
14
|
+
- Teams seeking a structured approach to AI-assisted software engineering
|
|
15
|
+
|
|
16
|
+
**What success looks like:**
|
|
17
|
+
- Features are implemented with full traceability from spec to code
|
|
18
|
+
- Tests are written before implementation, providing a stable contract
|
|
19
|
+
- All artifacts (specs, stories, tests, code) are aligned and consistent
|
|
20
|
+
|
|
21
|
+
**What must not be compromised:**
|
|
22
|
+
- Explicit specification before implementation
|
|
23
|
+
- Test-first development contracts
|
|
24
|
+
- Agent role boundaries and handoff integrity
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 2. Business & Domain Context
|
|
29
|
+
|
|
30
|
+
orchestr8 operates in the domain of AI-assisted software development, specifically within the Claude Code CLI environment.
|
|
31
|
+
|
|
32
|
+
**Relevant drivers:**
|
|
33
|
+
- Growing adoption of AI coding assistants
|
|
34
|
+
- Need for structured processes to guide AI-generated code
|
|
35
|
+
- Requirement for traceability and quality assurance in automated development
|
|
36
|
+
|
|
37
|
+
**Domain constraints:**
|
|
38
|
+
- Operates within Claude Code's Task tool for spawning sub-agents
|
|
39
|
+
- Subject to Claude's token limits (optimized via incremental writes)
|
|
40
|
+
- Relies on file-based artifacts for persistence and handoffs
|
|
41
|
+
|
|
42
|
+
**Assumptions:**
|
|
43
|
+
- Users have Node.js 18+ installed
|
|
44
|
+
- Users have Claude Code CLI available
|
|
45
|
+
- Projects use standard testing frameworks (Jest, Node test runner)
|
|
46
|
+
- The `.business_context/` directory contains project-specific domain knowledge
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 3. System Boundaries
|
|
51
|
+
|
|
52
|
+
### In Scope
|
|
53
|
+
|
|
54
|
+
- **CLI tooling:** `init`, `update`, `skills`, `add-skills`, `queue` commands
|
|
55
|
+
- **Agent orchestration:** Sequential pipeline via `/implement-feature` skill
|
|
56
|
+
- **Artifact management:** Feature specs, user stories, test specs, tests, implementation plans
|
|
57
|
+
- **Queue persistence:** Recovery and resumption from `.claude/implement-queue.json`
|
|
58
|
+
- **Skills integration:** Installing optional skills from skills.sh ecosystem
|
|
59
|
+
|
|
60
|
+
### Out of Scope
|
|
61
|
+
|
|
62
|
+
- Runtime test execution environment (assumes existing test infrastructure)
|
|
63
|
+
- CI/CD integration (users configure their own pipelines)
|
|
64
|
+
- Project-specific business logic (provided via `.business_context/`)
|
|
65
|
+
- IDE integration beyond Claude Code CLI
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 4. Actors & Roles
|
|
70
|
+
|
|
71
|
+
### Human User
|
|
72
|
+
- **Description:** Developer invoking orchestr8 commands and the `/implement-feature` skill
|
|
73
|
+
- **Primary goals:** Automate feature development, maintain control over scope and quality
|
|
74
|
+
- **Authority:** Final arbiter on intent, scope, and breaking changes; can pause/abort pipeline
|
|
75
|
+
|
|
76
|
+
### Alex (System Specification & Chief-of-Staff)
|
|
77
|
+
- **Description:** Creates and maintains system and feature specifications
|
|
78
|
+
- **Primary goals:** Prevent drift, ensure coherence, produce feature specs for downstream agents
|
|
79
|
+
- **Authority:** Can define and evolve specifications; cannot make unilateral product decisions
|
|
80
|
+
|
|
81
|
+
### Cass (Story Writer / Business Analyst)
|
|
82
|
+
- **Description:** Translates feature specs into user stories and acceptance criteria
|
|
83
|
+
- **Primary goals:** Produce explicit, testable, behaviour-first stories
|
|
84
|
+
- **Authority:** Elaborates specifications into stories; does not introduce unspecified behaviour
|
|
85
|
+
|
|
86
|
+
### Nigel (Tester)
|
|
87
|
+
- **Description:** Creates test specifications and executable tests from user stories
|
|
88
|
+
- **Primary goals:** Expose ambiguities, provide stable test contracts
|
|
89
|
+
- **Authority:** Defines test coverage; does not implement production code
|
|
90
|
+
|
|
91
|
+
### Codey (Developer)
|
|
92
|
+
- **Description:** Implements features according to plans and test contracts
|
|
93
|
+
- **Primary goals:** Make tests pass, maintain code quality
|
|
94
|
+
- **Authority:** Writes implementation code; does not modify tests without agreement
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 5. Core Domain Concepts
|
|
99
|
+
|
|
100
|
+
### Feature
|
|
101
|
+
- **Definition:** A bounded unit of functionality identified by a slug (e.g., `user-auth`)
|
|
102
|
+
- **Key attributes:** slug, feature spec, user stories, tests, implementation plan
|
|
103
|
+
- **Lifecycle:** Created by Alex, elaborated by Cass, tested by Nigel, implemented by Codey
|
|
104
|
+
|
|
105
|
+
### Pipeline Stage
|
|
106
|
+
- **Definition:** A discrete phase in the feature development workflow
|
|
107
|
+
- **Key attributes:** agent owner, input artifacts, output artifacts
|
|
108
|
+
- **Stages:** alex, cass, nigel, codey-plan, codey-implement, auto-commit
|
|
109
|
+
|
|
110
|
+
### Queue
|
|
111
|
+
- **Definition:** Persistent state tracking features through the pipeline
|
|
112
|
+
- **Key attributes:** current, alexQueue, cassQueue, nigelQueue, codeyQueue, completed, failed
|
|
113
|
+
- **Lifecycle:** Created on first run, updated at each stage transition, cleared on completion
|
|
114
|
+
|
|
115
|
+
### Artifact
|
|
116
|
+
- **Definition:** A file produced by an agent as output
|
|
117
|
+
- **Types:** SYSTEM_SPEC.md, FEATURE_SPEC.md, story-*.md, test-spec.md, *.test.js, IMPLEMENTATION_PLAN.md
|
|
118
|
+
|
|
119
|
+
### Skill
|
|
120
|
+
- **Definition:** A Claude Code command that provides specialized agent capabilities
|
|
121
|
+
- **Key attributes:** name, description, prompt template
|
|
122
|
+
- **Lifecycle:** Installed via `add-skills`, invoked via slash commands
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
## 6. High-Level Lifecycle & State Model
|
|
127
|
+
|
|
128
|
+
### Pipeline Lifecycle
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
INIT → ALEX → CASS → NIGEL → CODEY_PLAN → CODEY_IMPLEMENT → COMMIT → COMPLETE
|
|
132
|
+
↓
|
|
133
|
+
PAUSED (--pause-after)
|
|
134
|
+
↓
|
|
135
|
+
RESUME
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Feature States
|
|
139
|
+
|
|
140
|
+
| State | Entry Condition | Exit Condition |
|
|
141
|
+
|-------|----------------|----------------|
|
|
142
|
+
| **pending** | Feature slug provided | Agent starts processing |
|
|
143
|
+
| **in_progress** | Agent spawned for stage | Agent completes or fails |
|
|
144
|
+
| **completed** | All stages pass, commit done | Moved to completed list |
|
|
145
|
+
| **failed** | Agent error or abort | Moved to failed list |
|
|
146
|
+
|
|
147
|
+
### Recovery
|
|
148
|
+
- On re-invocation, pipeline reads `current.stage` from queue and resumes
|
|
149
|
+
- Failed features can be retried or restarted from scratch
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 7. Governing Rules & Invariants
|
|
154
|
+
|
|
155
|
+
### Pipeline Rules
|
|
156
|
+
- **Sequential execution:** Agents execute in order (Alex → Cass → Nigel → Codey)
|
|
157
|
+
- **Artifact gates:** Each stage requires output artifacts before proceeding
|
|
158
|
+
- **System spec gate:** Pipeline cannot proceed without SYSTEM_SPEC.md
|
|
159
|
+
|
|
160
|
+
### Agent Rules
|
|
161
|
+
- **Single responsibility:** Each agent has defined inputs and outputs; no overlap
|
|
162
|
+
- **No silent changes:** Agents flag deviations; do not silently alter specifications
|
|
163
|
+
- **Incremental output:** All agents write one file at a time to avoid token limits
|
|
164
|
+
|
|
165
|
+
### Queue Rules
|
|
166
|
+
- **Single current:** Only one feature can be `current` at a time
|
|
167
|
+
- **Immutable completed:** Completed features are not re-processed unless explicitly restarted
|
|
168
|
+
- **Recovery-safe:** Queue file enables resumption after failures
|
|
169
|
+
|
|
170
|
+
### Implementation Rules
|
|
171
|
+
- **Tests are contracts:** Codey implements against tests, not around them
|
|
172
|
+
- **No test deletion:** Tests cannot be removed without explicit approval
|
|
173
|
+
- **Green suite required:** Implementation is complete only when all tests pass
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## 8. Cross-Cutting Concerns
|
|
178
|
+
|
|
179
|
+
### Traceability
|
|
180
|
+
- Every test maps to acceptance criteria (AC → Test ID table)
|
|
181
|
+
- Every story maps to feature spec sections
|
|
182
|
+
- Commit messages reference artifacts and agents
|
|
183
|
+
|
|
184
|
+
### Token Limit Management
|
|
185
|
+
- Incremental file writes (one file at a time)
|
|
186
|
+
- Brief summaries (5 bullets max)
|
|
187
|
+
- Reference by path instead of quoting content
|
|
188
|
+
- Consolidated artifacts (Nigel: 2 files, not 4)
|
|
189
|
+
|
|
190
|
+
### Failure Handling
|
|
191
|
+
- Each agent spawn offers: retry, skip, abort
|
|
192
|
+
- Failures are recorded with stage, reason, and timestamp
|
|
193
|
+
- Queue persists state for recovery
|
|
194
|
+
|
|
195
|
+
### Observability
|
|
196
|
+
- Queue status available via `orchestr8 queue`
|
|
197
|
+
- Each agent provides completion summary
|
|
198
|
+
- Commit messages document pipeline execution
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
## 9. Non-Functional Expectations
|
|
203
|
+
|
|
204
|
+
### Reliability
|
|
205
|
+
- Pipeline resumes from last checkpoint on failure
|
|
206
|
+
- Queue file is gitignored to avoid conflicts
|
|
207
|
+
- Deterministic output given same inputs
|
|
208
|
+
|
|
209
|
+
### Performance
|
|
210
|
+
- Optimized for Claude's 4096 output token limit
|
|
211
|
+
- Incremental processing reduces memory pressure
|
|
212
|
+
- Skills installed once per project
|
|
213
|
+
|
|
214
|
+
### Extensibility
|
|
215
|
+
- Skills can be added per-agent from skills.sh ecosystem
|
|
216
|
+
- Agent specifications can be customized in `.blueprint/agents/`
|
|
217
|
+
- Business context directory allows project-specific grounding
|
|
218
|
+
|
|
219
|
+
### Maintainability
|
|
220
|
+
- `update` command replaces framework files while preserving user content
|
|
221
|
+
- Clear separation: framework dirs (replaced) vs user dirs (preserved)
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## 10. Known Gaps, Risks & Open Questions
|
|
226
|
+
|
|
227
|
+
### Known Limitations
|
|
228
|
+
- Pipeline is sequential; no parallel agent execution
|
|
229
|
+
- Single-feature focus; no batch processing
|
|
230
|
+
- Assumes Node.js testing ecosystem
|
|
231
|
+
|
|
232
|
+
### Risks
|
|
233
|
+
- Token limit errors if agents generate excessive output
|
|
234
|
+
- Agent specifications may need tuning for non-standard projects
|
|
235
|
+
- Skill installation requires network access
|
|
236
|
+
|
|
237
|
+
### Open Questions
|
|
238
|
+
- Should agents support alternative testing frameworks?
|
|
239
|
+
- Could pipeline stages be made configurable or skippable?
|
|
240
|
+
- How to handle features that span multiple repositories?
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## 11. Change Log (System-Level)
|
|
245
|
+
|
|
246
|
+
| Date | Change | Reason | Approved By |
|
|
247
|
+
|------|--------|--------|-------------|
|
|
248
|
+
| 2026-02-24 | Initial system specification | Document orchestr8 v2.5.0 | Alex |
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# orchestr8
|
|
2
2
|
|
|
3
|
-
A multi-agent workflow framework for automated feature development. Four specialized AI agents collaborate in sequence to take features from specification to implementation.
|
|
3
|
+
A multi-agent workflow framework for automated feature development. Four specialized AI agents collaborate in sequence to take features from specification to implementation, with built-in feedback loops and self-improvement capabilities.
|
|
4
4
|
|
|
5
5
|
## Agents
|
|
6
6
|
|
|
@@ -19,53 +19,155 @@ npx orchestr8 init
|
|
|
19
19
|
|
|
20
20
|
This installs the `.blueprint/` directory, `.business_context/`, and the `/implement-feature` skill to `.claude/commands/`. If files already exist, you'll be prompted before overwriting. It also adds the workflow queue to `.gitignore`.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
## Keeping Up to Date
|
|
23
|
+
|
|
24
|
+
**Modules** (history, insights, feedback, retry, validate) are part of the npm package and update automatically when you use `npx` - no action needed.
|
|
25
|
+
|
|
26
|
+
**Project files** (agent specs, templates, skill definition) are copied to your project and need explicit updating:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx orchestr8 update
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
This updates `.blueprint/agents/`, `.blueprint/templates/`, `.blueprint/ways_of_working/`, and `.claude/commands/implement-feature.md` while preserving your content in `features/` and `system_specification/`.
|
|
33
|
+
|
|
34
|
+
## Commands
|
|
35
|
+
|
|
36
|
+
### Core Commands
|
|
23
37
|
|
|
24
38
|
| Command | Description |
|
|
25
39
|
|---------|-------------|
|
|
26
40
|
| `npx orchestr8 init` | Initialize `.blueprint/`, `.business_context/`, and skill in your project |
|
|
27
41
|
| `npx orchestr8 update` | Update agents, templates, and rituals to latest version |
|
|
28
|
-
| `npx orchestr8
|
|
29
|
-
| `npx orchestr8 skills [agent]` | List recommended skills |
|
|
42
|
+
| `npx orchestr8 validate` | Pre-flight checks before running pipeline |
|
|
30
43
|
| `npx orchestr8 help` | Show help |
|
|
31
44
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
### Optional Skills
|
|
45
|
+
### History & Insights
|
|
35
46
|
|
|
36
|
-
|
|
47
|
+
| Command | Description |
|
|
48
|
+
|---------|-------------|
|
|
49
|
+
| `npx orchestr8 history` | View recent pipeline runs |
|
|
50
|
+
| `npx orchestr8 history --stats` | View aggregate statistics |
|
|
51
|
+
| `npx orchestr8 history --all` | View all runs |
|
|
52
|
+
| `npx orchestr8 history clear` | Clear history |
|
|
53
|
+
| `npx orchestr8 insights` | Analyze patterns and get recommendations |
|
|
54
|
+
| `npx orchestr8 insights --feedback` | View feedback correlation analysis |
|
|
55
|
+
| `npx orchestr8 insights --bottlenecks` | View bottleneck analysis |
|
|
56
|
+
| `npx orchestr8 insights --failures` | View failure pattern analysis |
|
|
37
57
|
|
|
38
|
-
|
|
39
|
-
|-------|--------|
|
|
40
|
-
| **Alex** | `avoid-feature-creep`, `feature-spec` |
|
|
41
|
-
| **Cass** | `user-story-writing` |
|
|
42
|
-
| **Nigel** | `javascript-testing-patterns`, `modern-javascript-patterns` |
|
|
43
|
-
| **Codey** | `javascript-expert`, `modern-javascript-patterns` |
|
|
58
|
+
### Configuration
|
|
44
59
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
npx orchestr8
|
|
48
|
-
|
|
60
|
+
| Command | Description |
|
|
61
|
+
|---------|-------------|
|
|
62
|
+
| `npx orchestr8 retry-config` | View retry configuration |
|
|
63
|
+
| `npx orchestr8 retry-config set <key> <value>` | Modify retry settings |
|
|
64
|
+
| `npx orchestr8 retry-config reset` | Reset to defaults |
|
|
65
|
+
| `npx orchestr8 feedback-config` | View feedback thresholds |
|
|
66
|
+
| `npx orchestr8 feedback-config set <key> <value>` | Modify feedback settings |
|
|
49
67
|
|
|
50
68
|
## Usage
|
|
51
69
|
|
|
52
70
|
Run the pipeline with the `/implement-feature` skill in Claude Code:
|
|
53
71
|
|
|
54
72
|
```bash
|
|
55
|
-
/implement-feature
|
|
56
|
-
/implement-feature "user-auth"
|
|
57
|
-
/implement-feature "user-auth" --
|
|
58
|
-
/implement-feature "user-auth" --
|
|
59
|
-
/implement-feature --
|
|
73
|
+
/implement-feature # Interactive
|
|
74
|
+
/implement-feature "user-auth" # New feature
|
|
75
|
+
/implement-feature "user-auth" --no-feedback # Skip feedback collection
|
|
76
|
+
/implement-feature "user-auth" --no-validate # Skip pre-flight validation
|
|
77
|
+
/implement-feature "user-auth" --no-history # Skip history recording
|
|
78
|
+
/implement-feature "user-auth" --no-commit # Skip auto-commit
|
|
79
|
+
/implement-feature "user-auth" --pause-after=alex|cass|nigel|codey-plan
|
|
60
80
|
```
|
|
61
81
|
|
|
62
|
-
|
|
82
|
+
## Pipeline Flow
|
|
83
|
+
|
|
84
|
+
The pipeline now includes validation, feedback loops, and history tracking:
|
|
63
85
|
|
|
64
86
|
```
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
87
|
+
┌─────────────────────────────────────────────────────────────────┐
|
|
88
|
+
│ Step 0: Pre-flight Validation │
|
|
89
|
+
│ • Check directories, specs, Node.js version │
|
|
90
|
+
└─────────────────────────────────────────────────────────────────┘
|
|
91
|
+
│
|
|
92
|
+
▼
|
|
93
|
+
┌─────────────────────────────────────────────────────────────────┐
|
|
94
|
+
│ Insights Preview │
|
|
95
|
+
│ • "Last 10 runs: 85% success, estimated ~12 min" │
|
|
96
|
+
└─────────────────────────────────────────────────────────────────┘
|
|
97
|
+
│
|
|
98
|
+
▼
|
|
99
|
+
┌─────────────────────────────────────────────────────────────────┐
|
|
100
|
+
│ Alex (Feature Spec) │
|
|
101
|
+
│ │ │
|
|
102
|
+
│ ▼ │
|
|
103
|
+
│ Cass rates Alex → Quality Gate (pause if rating < 3) │
|
|
104
|
+
│ │ │
|
|
105
|
+
│ ▼ │
|
|
106
|
+
│ Cass (User Stories) │
|
|
107
|
+
│ │ │
|
|
108
|
+
│ ▼ │
|
|
109
|
+
│ Nigel rates Cass → Quality Gate │
|
|
110
|
+
│ │ │
|
|
111
|
+
│ ▼ │
|
|
112
|
+
│ Nigel (Tests) │
|
|
113
|
+
│ │ │
|
|
114
|
+
│ ▼ │
|
|
115
|
+
│ Codey rates Nigel → Quality Gate │
|
|
116
|
+
│ │ │
|
|
117
|
+
│ ▼ │
|
|
118
|
+
│ Codey (Plan → Implement) │
|
|
119
|
+
└─────────────────────────────────────────────────────────────────┘
|
|
120
|
+
│
|
|
121
|
+
On Failure│
|
|
122
|
+
▼
|
|
123
|
+
┌─────────────────────────────────────────────────────────────────┐
|
|
124
|
+
│ Smart Retry │
|
|
125
|
+
│ • Check feedback chain for root cause │
|
|
126
|
+
│ • Recommend strategy based on history │
|
|
127
|
+
│ • Apply: simplify-prompt, add-context, incremental, etc. │
|
|
128
|
+
└─────────────────────────────────────────────────────────────────┘
|
|
129
|
+
│
|
|
130
|
+
▼
|
|
131
|
+
┌─────────────────────────────────────────────────────────────────┐
|
|
132
|
+
│ Auto-commit → Record to History │
|
|
133
|
+
│ • Duration, feedback scores, outcome │
|
|
134
|
+
└─────────────────────────────────────────────────────────────────┘
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Modules
|
|
138
|
+
|
|
139
|
+
orchestr8 includes these built-in modules for observability and self-improvement:
|
|
140
|
+
|
|
141
|
+
| Module | Purpose |
|
|
142
|
+
|--------|---------|
|
|
143
|
+
| **validate** | Pre-flight checks before pipeline runs |
|
|
144
|
+
| **history** | Records execution data (timing, status, feedback) |
|
|
145
|
+
| **insights** | Analyzes patterns, detects bottlenecks, recommends improvements |
|
|
146
|
+
| **retry** | Smart retry strategies based on failure history |
|
|
147
|
+
| **feedback** | Agent-to-agent quality assessment with correlation tracking |
|
|
148
|
+
|
|
149
|
+
### How They Work Together
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
Pipeline Run
|
|
153
|
+
│
|
|
154
|
+
├──► history.js records timing at each stage
|
|
155
|
+
│
|
|
156
|
+
├──► feedback.js collects quality ratings between stages
|
|
157
|
+
│
|
|
158
|
+
└──► On completion/failure, data stored in pipeline-history.json
|
|
159
|
+
│
|
|
160
|
+
▼
|
|
161
|
+
Future Pipeline Runs
|
|
162
|
+
│
|
|
163
|
+
┌────────────────────────┼────────────────────────┐
|
|
164
|
+
│ │ │
|
|
165
|
+
▼ ▼ ▼
|
|
166
|
+
insights.js retry.js feedback.js
|
|
167
|
+
analyzes: recommends: calibrates:
|
|
168
|
+
• Bottlenecks • Retry strategies • Quality thresholds
|
|
169
|
+
• Failure patterns • Based on history • Agent accuracy
|
|
170
|
+
• Trends • And feedback issues
|
|
69
171
|
```
|
|
70
172
|
|
|
71
173
|
## Directory Structure
|
|
@@ -73,7 +175,7 @@ Update System: Alex → cascade check
|
|
|
73
175
|
```
|
|
74
176
|
your-project/
|
|
75
177
|
├── .blueprint/
|
|
76
|
-
│ ├── agents/ # Agent specifications
|
|
178
|
+
│ ├── agents/ # Agent specifications (with guardrails)
|
|
77
179
|
│ │ ├── AGENT_SPECIFICATION_ALEX.md
|
|
78
180
|
│ │ ├── AGENT_BA_CASS.md
|
|
79
181
|
│ │ ├── AGENT_TESTER_NIGEL.md
|
|
@@ -86,19 +188,61 @@ your-project/
|
|
|
86
188
|
│ └── system_specification/ # System spec (populated on first run)
|
|
87
189
|
├── .business_context/ # Business context documents
|
|
88
190
|
│ └── README.md
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
191
|
+
├── .claude/
|
|
192
|
+
│ ├── commands/
|
|
193
|
+
│ │ └── implement-feature.md # The /implement-feature skill
|
|
194
|
+
│ ├── pipeline-history.json # Execution history (gitignored)
|
|
195
|
+
│ ├── retry-config.json # Retry configuration (gitignored)
|
|
196
|
+
│ ├── feedback-config.json # Feedback thresholds (gitignored)
|
|
197
|
+
│ └── implement-queue.json # Pipeline queue state (gitignored)
|
|
198
|
+
└── test/
|
|
199
|
+
├── artifacts/ # Test specs per feature
|
|
200
|
+
└── feature_*.test.js # Executable tests
|
|
92
201
|
```
|
|
93
202
|
|
|
94
|
-
##
|
|
203
|
+
## Agent Guardrails
|
|
204
|
+
|
|
205
|
+
All agents follow strict guardrails to ensure quality:
|
|
206
|
+
|
|
207
|
+
| Guardrail | Description |
|
|
208
|
+
|-----------|-------------|
|
|
209
|
+
| **Source Restrictions** | Only use provided inputs (specs, code, business_context) |
|
|
210
|
+
| **Prohibited Sources** | No social media, forums, external APIs, training data for domain facts |
|
|
211
|
+
| **Citation Requirements** | All claims must cite source files |
|
|
212
|
+
| **Confidentiality** | Business context treated as confidential |
|
|
213
|
+
| **Escalation Protocol** | Clear rules for when to ask vs assume |
|
|
95
214
|
|
|
96
|
-
|
|
97
|
-
2. **Cass** writes user stories with acceptance criteria from the feature spec
|
|
98
|
-
3. **Nigel** creates test plans, behavior matrices, and executable tests
|
|
99
|
-
4. **Codey** implements code to pass the tests, then auto-commits
|
|
215
|
+
## Self-Improvement Loop
|
|
100
216
|
|
|
101
|
-
The pipeline
|
|
217
|
+
The pipeline learns from itself:
|
|
218
|
+
|
|
219
|
+
1. **Record** — Each run records timing, feedback, and outcomes
|
|
220
|
+
2. **Analyze** — `orchestr8 insights` identifies patterns
|
|
221
|
+
3. **Adapt** — Future runs use history to:
|
|
222
|
+
- Set dynamic quality thresholds
|
|
223
|
+
- Select optimal retry strategies
|
|
224
|
+
- Predict duration and success rate
|
|
225
|
+
4. **Improve** — Feedback patterns suggest prompt improvements
|
|
226
|
+
|
|
227
|
+
```bash
|
|
228
|
+
# Example insights output
|
|
229
|
+
$ npx orchestr8 insights
|
|
230
|
+
|
|
231
|
+
## Pipeline Insights
|
|
232
|
+
|
|
233
|
+
### Bottlenecks
|
|
234
|
+
- nigel averages 4.2 min (42% of pipeline time)
|
|
235
|
+
- Recommendation: Consider simplifying test requirements
|
|
236
|
+
|
|
237
|
+
### Failure Patterns
|
|
238
|
+
- codey-implement has 23% failure rate
|
|
239
|
+
- Most common issue: "missing-error-handling" (73% correlation)
|
|
240
|
+
- Recommendation: Ensure Alex includes error handling in specs
|
|
241
|
+
|
|
242
|
+
### Trends
|
|
243
|
+
- Success rate: 75% → 85% (improving)
|
|
244
|
+
- Avg duration: 14 min → 11 min (improving)
|
|
245
|
+
```
|
|
102
246
|
|
|
103
247
|
## License
|
|
104
248
|
|