convoke-agents 2.4.0 → 3.0.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/CHANGELOG.md +16 -0
- package/INSTALLATION.md +109 -86
- package/README.md +220 -163
- package/UPDATE-GUIDE.md +63 -23
- package/_bmad/bme/_gyre/README.md +100 -0
- package/_bmad/bme/_gyre/agents/.gitkeep +0 -0
- package/_bmad/bme/_gyre/agents/model-curator.md +128 -0
- package/_bmad/bme/_gyre/agents/readiness-analyst.md +127 -0
- package/_bmad/bme/_gyre/agents/review-coach.md +130 -0
- package/_bmad/bme/_gyre/agents/stack-detective.md +125 -0
- package/_bmad/bme/_gyre/compass-routing-reference.md +168 -0
- package/_bmad/bme/_gyre/config.yaml +22 -0
- package/_bmad/bme/_gyre/contracts/.gitkeep +0 -0
- package/_bmad/bme/_gyre/contracts/gc1-stack-profile.md +152 -0
- package/_bmad/bme/_gyre/contracts/gc2-capabilities-manifest.md +189 -0
- package/_bmad/bme/_gyre/contracts/gc3-findings-report.md +197 -0
- package/_bmad/bme/_gyre/contracts/gc4-feedback-loop.md +209 -0
- package/_bmad/bme/_gyre/guides/ATLAS-USER-GUIDE.md +177 -0
- package/_bmad/bme/_gyre/guides/COACH-USER-GUIDE.md +172 -0
- package/_bmad/bme/_gyre/guides/LENS-USER-GUIDE.md +181 -0
- package/_bmad/bme/_gyre/guides/SCOUT-USER-GUIDE.md +158 -0
- package/_bmad/bme/_gyre/workflows/.gitkeep +0 -0
- package/_bmad/bme/_gyre/workflows/accuracy-validation/steps/step-01-select-repos.md +55 -0
- package/_bmad/bme/_gyre/workflows/accuracy-validation/steps/step-02-run-validation.md +78 -0
- package/_bmad/bme/_gyre/workflows/accuracy-validation/steps/step-03-score-results.md +143 -0
- package/_bmad/bme/_gyre/workflows/accuracy-validation/workflow.md +41 -0
- package/_bmad/bme/_gyre/workflows/delta-report/steps/step-01-load-history.md +63 -0
- package/_bmad/bme/_gyre/workflows/delta-report/steps/step-02-compute-delta.md +72 -0
- package/_bmad/bme/_gyre/workflows/delta-report/steps/step-03-present-delta.md +143 -0
- package/_bmad/bme/_gyre/workflows/delta-report/workflow.md +34 -0
- package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-01-initialize.md +68 -0
- package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-02-detect-stack.md +49 -0
- package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-03-generate-model.md +52 -0
- package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-04-analyze-gaps.md +42 -0
- package/_bmad/bme/_gyre/workflows/full-analysis/steps/step-05-review-findings.md +128 -0
- package/_bmad/bme/_gyre/workflows/full-analysis/workflow.md +39 -0
- package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-01-load-manifest.md +70 -0
- package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-02-observability-analysis.md +110 -0
- package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-03-deployment-analysis.md +87 -0
- package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-04-cross-domain-correlation.md +105 -0
- package/_bmad/bme/_gyre/workflows/gap-analysis/steps/step-05-present-findings.md +172 -0
- package/_bmad/bme/_gyre/workflows/gap-analysis/workflow.md +38 -0
- package/_bmad/bme/_gyre/workflows/model-generation/steps/step-01-load-profile.md +74 -0
- package/_bmad/bme/_gyre/workflows/model-generation/steps/step-02-generate-capabilities.md +116 -0
- package/_bmad/bme/_gyre/workflows/model-generation/steps/step-03-web-enrichment.md +89 -0
- package/_bmad/bme/_gyre/workflows/model-generation/steps/step-04-write-manifest.md +122 -0
- package/_bmad/bme/_gyre/workflows/model-generation/workflow.md +40 -0
- package/_bmad/bme/_gyre/workflows/model-review/steps/step-01-load-context.md +86 -0
- package/_bmad/bme/_gyre/workflows/model-review/steps/step-02-walkthrough.md +116 -0
- package/_bmad/bme/_gyre/workflows/model-review/steps/step-03-apply-amendments.md +92 -0
- package/_bmad/bme/_gyre/workflows/model-review/steps/step-04-capture-feedback.md +107 -0
- package/_bmad/bme/_gyre/workflows/model-review/steps/step-05-summary.md +60 -0
- package/_bmad/bme/_gyre/workflows/model-review/workflow.md +41 -0
- package/_bmad/bme/_gyre/workflows/stack-detection/steps/step-01-scan-filesystem.md +176 -0
- package/_bmad/bme/_gyre/workflows/stack-detection/steps/step-02-classify-stack.md +111 -0
- package/_bmad/bme/_gyre/workflows/stack-detection/steps/step-03-guard-questions.md +117 -0
- package/_bmad/bme/_gyre/workflows/stack-detection/workflow.md +42 -0
- package/_bmad/bme/_vortex/config.yaml +1 -1
- package/package.json +5 -2
- package/scripts/archive.js +304 -0
- package/scripts/convoke-doctor.js +146 -132
- package/scripts/docs-audit.js +21 -5
- package/scripts/install-gyre-agents.js +140 -0
- package/scripts/install-vortex-agents.js +0 -0
- package/scripts/update/lib/agent-registry.js +70 -0
- package/scripts/update/lib/refresh-installation.js +152 -30
- package/scripts/update/lib/validator.js +160 -1
package/README.md
CHANGED
|
@@ -10,14 +10,24 @@
|
|
|
10
10
|
Agent teams for complex systems
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
[](https://github.com/amalik/convoke-agents)
|
|
14
14
|
[](LICENSE)
|
|
15
15
|
|
|
16
16
|
</div>
|
|
17
17
|
|
|
18
|
-
Convoke extends AI agents with two types of installable modules: **Teams** bring new agents for a domain, **Skills** add new capabilities to existing agents.
|
|
18
|
+
Convoke extends AI agents with two types of installable modules: **Teams** bring new agents for a domain, **Skills** add new capabilities to existing agents. Install them independently or combine them.
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
| Team | Agents | Domain |
|
|
21
|
+
|------|--------|--------|
|
|
22
|
+
| **Vortex** | 7 agents, 22 workflows | Product discovery — from user insight to evidence-based decisions |
|
|
23
|
+
| **Gyre** | 4 agents, 7 workflows | Production readiness — from stack detection to gap analysis |
|
|
24
|
+
|
|
25
|
+
### What's New
|
|
26
|
+
|
|
27
|
+
- **Gyre team** — 4 agents analyze your project's production readiness: detect your stack, model what "ready" looks like, find what's missing, and help you act on it
|
|
28
|
+
- **Team Factory** — guided workflow for creating new BMAD-compliant teams from scratch (`/bmad-team-factory`)
|
|
29
|
+
- **Skill Validator** — new `validateSkill()` quality gate in the update system for factory-generated skills ([development docs](docs/development.md))
|
|
30
|
+
- See the [CHANGELOG](CHANGELOG.md) for the full release details
|
|
21
31
|
|
|
22
32
|
---
|
|
23
33
|
|
|
@@ -28,8 +38,6 @@ Convoke extends AI agents with two types of installable modules: **Teams** bring
|
|
|
28
38
|
[](docs/agents.md)
|
|
29
39
|
[](docs/agents.md)
|
|
30
40
|
|
|
31
|
-
**Most teams skip validation and build on assumptions.**
|
|
32
|
-
|
|
33
41
|
Vortex guides you through seven discovery streams — from understanding your users to interpreting production signals — so you can make evidence-based decisions before, during, and after you build. Each stream builds on the previous one's findings, and when gaps appear, the system routes you back to fill them.
|
|
34
42
|
|
|
35
43
|
```
|
|
@@ -51,7 +59,17 @@ Vortex guides you through seven discovery streams — from understanding your us
|
|
|
51
59
|
▶ Start at Emma · back to any stream
|
|
52
60
|
```
|
|
53
61
|
|
|
54
|
-
*
|
|
62
|
+
*Each workflow ends with a Compass routing to whichever stream needs attention — you can start or return to any agent.*
|
|
63
|
+
|
|
64
|
+
| Agent | Stream | What they do |
|
|
65
|
+
|-------|--------|-------------|
|
|
66
|
+
| **Emma** 🎯 | Contextualize | Frame the right problem — personas, product vision, scope |
|
|
67
|
+
| **Isla** 🔍 | Empathize | Understand users — empathy maps, interviews, discovery research |
|
|
68
|
+
| **Mila** 🔬 | Synthesize | Converge research into clear problem definitions |
|
|
69
|
+
| **Liam** 💡 | Hypothesize | Turn problems into testable hypotheses and experiments |
|
|
70
|
+
| **Wade** 🧪 | Externalize | Test assumptions with MVPs, experiments, and prototypes |
|
|
71
|
+
| **Noah** 📡 | Sensitize | Interpret production signals, user behavior, and engagement patterns |
|
|
72
|
+
| **Max** 🧭 | Systematize | Capture learnings and decide: pivot, patch, or persevere |
|
|
55
73
|
|
|
56
74
|
<details>
|
|
57
75
|
<summary>22 Vortex Workflows</summary>
|
|
@@ -81,16 +99,6 @@ Vortex guides you through seven discovery streams — from understanding your us
|
|
|
81
99
|
|
|
82
100
|
</details>
|
|
83
101
|
|
|
84
|
-
| Agent | Stream | What they do |
|
|
85
|
-
|-------|--------|-------------|
|
|
86
|
-
| **Emma** 🎯 | Contextualize | Frame the right problem — personas, product vision, scope |
|
|
87
|
-
| **Isla** 🔍 | Empathize | Understand users — empathy maps, interviews, discovery research |
|
|
88
|
-
| **Mila** 🔬 | Synthesize | Converge research into clear problem definitions |
|
|
89
|
-
| **Liam** 💡 | Hypothesize | Turn problems into testable hypotheses and experiments |
|
|
90
|
-
| **Wade** 🧪 | Externalize | Test assumptions with MVPs, experiments, and prototypes |
|
|
91
|
-
| **Noah** 📡 | Sensitize | Interpret production signals, user behavior, and engagement patterns |
|
|
92
|
-
| **Max** 🧭 | Systematize | Capture learnings and decide: pivot, patch, or persevere |
|
|
93
|
-
|
|
94
102
|
### What Agents Produce
|
|
95
103
|
|
|
96
104
|
Here's a sample of real output from a busy parents meal planning project — each excerpt is from the [full 7-agent journey example](_bmad-output/journey-examples/busy-parents-7-agent-journey.md).
|
|
@@ -125,222 +133,245 @@ Max captures what you learned and decides what to do next:
|
|
|
125
133
|
> The core hypothesis is validated. The product direction (decision elimination via single suggestion) is correct. The timing mechanism needs refinement — shift from fixed 4:00 PM delivery to adaptive delivery based on each user's observed engagement pattern.
|
|
126
134
|
>
|
|
127
135
|
> **Three Actions:**
|
|
128
|
-
> 1. **Implement adaptive timing** — shift the push notification to match each user's observed engagement window.
|
|
136
|
+
> 1. **Implement adaptive timing** — shift the push notification to match each user's observed engagement window.
|
|
129
137
|
> 2. **Route to Isla for timing investigation** — qualitative research on why users engage at 3:15 PM. Is it anxiety relief, logistical planning, or habit?
|
|
130
138
|
> 3. **Test willingness to pay immediately** — the mechanism works, but we have no commercial validation. Run a landing page test with pricing before further product investment.
|
|
131
139
|
|
|
132
|
-
Want to see the complete walkthrough of all 7 agents applied to the example above?
|
|
133
|
-
|
|
134
140
|
**[See the full 7-agent journey example →](_bmad-output/journey-examples/busy-parents-7-agent-journey.md)**
|
|
135
141
|
|
|
142
|
+
For detailed workflow descriptions, see the [Agent Guide](docs/agents.md) and individual user guides: [Emma](_bmad/bme/_vortex/guides/EMMA-USER-GUIDE.md) | [Isla](_bmad/bme/_vortex/guides/ISLA-USER-GUIDE.md) | [Mila](_bmad/bme/_vortex/guides/MILA-USER-GUIDE.md) | [Liam](_bmad/bme/_vortex/guides/LIAM-USER-GUIDE.md) | [Wade](_bmad/bme/_vortex/guides/WADE-USER-GUIDE.md) | [Noah](_bmad/bme/_vortex/guides/NOAH-USER-GUIDE.md) | [Max](_bmad/bme/_vortex/guides/MAX-USER-GUIDE.md)
|
|
143
|
+
|
|
136
144
|
---
|
|
137
145
|
|
|
138
|
-
|
|
146
|
+
## Gyre — Production Readiness Team
|
|
139
147
|
|
|
140
|
-
|
|
148
|
+
**4 agents assess whether your project is ready to ship — detect your stack, model what "ready" means, find what's missing, and refine together**
|
|
141
149
|
|
|
142
|
-
-
|
|
143
|
-
-
|
|
144
|
-
- Claude Code or Claude.ai
|
|
150
|
+
[](docs/agents.md)
|
|
151
|
+
[](docs/agents.md)
|
|
145
152
|
|
|
146
|
-
|
|
153
|
+
Most teams ship to production without knowing if they're actually ready — missing SLOs, incomplete observability, unreviewed deployment strategies. Gyre analyzes your project's filesystem, builds a capabilities model tailored to your specific tech stack, and surfaces what's absent. No generic checklists — every finding is contextual to your project.
|
|
147
154
|
|
|
148
|
-
```bash
|
|
149
|
-
npm install convoke-agents && npx -p convoke-agents convoke-install-vortex
|
|
150
155
|
```
|
|
156
|
+
4 Agents · 4 Contracts
|
|
151
157
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
**Claude Code (skills)**
|
|
161
|
-
|
|
162
|
-
```
|
|
163
|
-
/bmad-agent-bme-contextualization-expert # Emma 🎯
|
|
164
|
-
/bmad-agent-bme-discovery-empathy-expert # Isla 🔍
|
|
165
|
-
/bmad-agent-bme-research-convergence-specialist # Mila 🔬
|
|
166
|
-
/bmad-agent-bme-hypothesis-engineer # Liam 💡
|
|
167
|
-
/bmad-agent-bme-lean-experiments-specialist # Wade 🧪
|
|
168
|
-
/bmad-agent-bme-production-intelligence-specialist # Noah 📡
|
|
169
|
-
/bmad-agent-bme-learning-decision-expert # Max 🧭
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
**Claude Code (terminal) / Other AI assistants**
|
|
173
|
-
|
|
174
|
-
```bash
|
|
175
|
-
cat _bmad/bme/_vortex/agents/contextualization-expert.md # Emma 🎯
|
|
176
|
-
cat _bmad/bme/_vortex/agents/discovery-empathy-expert.md # Isla 🔍
|
|
177
|
-
cat _bmad/bme/_vortex/agents/research-convergence-specialist.md # Mila 🔬
|
|
178
|
-
cat _bmad/bme/_vortex/agents/hypothesis-engineer.md # Liam 💡
|
|
179
|
-
cat _bmad/bme/_vortex/agents/lean-experiments-specialist.md # Wade 🧪
|
|
180
|
-
cat _bmad/bme/_vortex/agents/production-intelligence-specialist.md # Noah 📡
|
|
181
|
-
cat _bmad/bme/_vortex/agents/learning-decision-expert.md # Max 🧭
|
|
158
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
159
|
+
│ Scout │──▶│ Atlas │──▶│ Lens │──▶│ Coach │
|
|
160
|
+
│ Detect │ │ Model │ │ Analyze │ │ Review │
|
|
161
|
+
│ Stack │ │ Capabil. │ │ Gaps │ │ Refine │
|
|
162
|
+
└─────────────┘ └──────▲──────┘ └─────────────┘ └──────┬──────┘
|
|
163
|
+
│ │
|
|
164
|
+
└────────────── GC4 ────────────────┘
|
|
165
|
+
feedback
|
|
182
166
|
```
|
|
183
167
|
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
Open any agent file from `_bmad/bme/_vortex/agents/` and paste its contents into your conversation.
|
|
187
|
-
|
|
188
|
-
**How activation works:** Each agent is a markdown file containing a full persona, menu system, and workflow instructions. When Claude reads the file, it adopts that agent's expertise and presents you with an interactive menu. Pick a workflow from the menu and follow the guided steps.
|
|
189
|
-
|
|
190
|
-
#### Your First 15 Minutes
|
|
191
|
-
|
|
192
|
-
1. **Personalize** — If you haven't already, edit `_bmad/bme/_vortex/config.yaml` and replace `{user}` with your name
|
|
193
|
-
2. **Activate Emma** — `cat _bmad/bme/_vortex/agents/contextualization-expert.md`
|
|
194
|
-
3. **See the menu** — Emma presents numbered options. Select **Lean Persona** from the menu
|
|
195
|
-
4. **Follow the steps** — Emma walks you through 6 guided steps, asking questions at each one
|
|
196
|
-
5. **Find your artifact** — When done, your lean persona is saved in `_bmad-output/vortex-artifacts/`
|
|
197
|
-
6. **Follow the Compass** — At the end, Emma's Vortex Compass suggests which agent to use next based on what you learned
|
|
198
|
-
|
|
199
|
-
Each workflow ends with a Compass routing suggestion. You don't need to follow a linear path — the system guides you to whichever stream needs attention.
|
|
200
|
-
|
|
201
|
-
#### What Gets Installed
|
|
202
|
-
|
|
203
|
-
```
|
|
204
|
-
your-project/
|
|
205
|
-
├── _bmad/bme/
|
|
206
|
-
│ ├── _vortex/ # Team: Product Discovery
|
|
207
|
-
│ │ ├── agents/ # 7 agent definition files
|
|
208
|
-
│ │ ├── workflows/ # 22 workflows
|
|
209
|
-
│ │ ├── contracts/ # Artifact contract schemas
|
|
210
|
-
│ │ ├── guides/ # User guides (all 7 agents)
|
|
211
|
-
│ │ └── config.yaml # Configuration
|
|
212
|
-
│ └── _enhance/ # Skill: Agent Capability Upgrades
|
|
213
|
-
│ ├── workflows/ # Skill workflows (initiatives-backlog)
|
|
214
|
-
│ ├── extensions/ # Agent menu patch descriptors
|
|
215
|
-
│ ├── guides/ # Module author guide
|
|
216
|
-
│ └── config.yaml # Configuration
|
|
217
|
-
└── _bmad-output/
|
|
218
|
-
└── vortex-artifacts/ # Generated artifacts
|
|
219
|
-
```
|
|
168
|
+
*Linear pipeline with a feedback loop. Coach amendments feed back to Atlas — the model improves with every review.*
|
|
220
169
|
|
|
221
|
-
|
|
170
|
+
| Agent | Role | What they do |
|
|
171
|
+
|-------|------|-------------|
|
|
172
|
+
| **Scout** 🔎 | Detect | Scan filesystem artifacts to classify your tech stack — language, containers, CI/CD, observability, cloud provider |
|
|
173
|
+
| **Atlas** 📐 | Model | Generate a capabilities manifest using industry standards (DORA, OpenTelemetry, Google PRR) and web search |
|
|
174
|
+
| **Lens** 🔬 | Analyze | Compare capabilities against what actually exists — surface absences, compound risks, severity-prioritized findings |
|
|
175
|
+
| **Coach** 🏋️ | Review | Walk through findings conversationally — amend the model, capture feedback, track progress over time |
|
|
222
176
|
|
|
223
|
-
|
|
177
|
+
<details>
|
|
178
|
+
<summary>7 Gyre Workflows</summary>
|
|
224
179
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
180
|
+
- Full Analysis (end-to-end pipeline)
|
|
181
|
+
- Stack Detection
|
|
182
|
+
- Model Generation
|
|
183
|
+
- Gap Analysis
|
|
184
|
+
- Model Review
|
|
185
|
+
- Delta Report
|
|
186
|
+
- Accuracy Validation
|
|
231
187
|
|
|
232
|
-
|
|
188
|
+
</details>
|
|
233
189
|
|
|
234
|
-
|
|
235
|
-
> ```bash
|
|
236
|
-
> npx -p convoke-agents@latest convoke-update --yes
|
|
237
|
-
> ```
|
|
190
|
+
### What Gyre Produces
|
|
238
191
|
|
|
239
|
-
|
|
192
|
+
Gyre writes structured artifacts to `.gyre/` in your project root — safe to commit, containing technology categories only (no file contents, paths, or secrets):
|
|
240
193
|
|
|
241
|
-
|
|
194
|
+
- **Stack Profile** (`.gyre/stack-profile.yaml`) — classified tech stack with detection confidence
|
|
195
|
+
- **Capabilities Manifest** (`.gyre/capabilities.yaml`) — 20+ capabilities across observability, deployment, reliability, and security
|
|
196
|
+
- **Findings Report** (`.gyre/findings.yaml`) — absence-based findings tagged by severity, confidence, and source
|
|
197
|
+
- **Feedback Log** (`.gyre/feedback.yaml`) — team amendments that persist and improve the model over time
|
|
242
198
|
|
|
243
|
-
|
|
199
|
+
**Three modes:** *Crisis* (first run, full pipeline), *Anticipation* (re-analysis with cached model), *Regeneration* (fresh model rebuild).
|
|
244
200
|
|
|
245
|
-
|
|
246
|
-
2. **Isla (Empathize)** — Start here when you need to understand users better
|
|
247
|
-
3. **Mila (Synthesize)** — Start here when you have research to converge into a problem definition
|
|
248
|
-
4. **Liam (Hypothesize)** — Start here when you have a problem definition and need testable hypotheses
|
|
249
|
-
5. **Wade (Externalize)** — Start here when you have hypotheses ready to test
|
|
250
|
-
6. **Noah (Sensitize)** — Start here when experiments have graduated to production
|
|
251
|
-
7. **Max (Systematize)** — Start here when you have results and need to decide next steps
|
|
201
|
+
**Delta tracking:** Run Gyre after making improvements to see what you've resolved — findings are tagged [NEW], [CARRIED], or resolved.
|
|
252
202
|
|
|
253
|
-
|
|
203
|
+
User guides: [Scout](_bmad/bme/_gyre/guides/SCOUT-USER-GUIDE.md) | [Atlas](_bmad/bme/_gyre/guides/ATLAS-USER-GUIDE.md) | [Lens](_bmad/bme/_gyre/guides/LENS-USER-GUIDE.md) | [Coach](_bmad/bme/_gyre/guides/COACH-USER-GUIDE.md)
|
|
254
204
|
|
|
255
|
-
|
|
205
|
+
---
|
|
256
206
|
|
|
257
|
-
|
|
258
|
-
- [Isla User Guide](_bmad/bme/_vortex/guides/ISLA-USER-GUIDE.md)
|
|
259
|
-
- [Mila User Guide](_bmad/bme/_vortex/guides/MILA-USER-GUIDE.md)
|
|
260
|
-
- [Liam User Guide](_bmad/bme/_vortex/guides/LIAM-USER-GUIDE.md)
|
|
261
|
-
- [Wade User Guide](_bmad/bme/_vortex/guides/WADE-USER-GUIDE.md)
|
|
262
|
-
- [Noah User Guide](_bmad/bme/_vortex/guides/NOAH-USER-GUIDE.md)
|
|
263
|
-
- [Max User Guide](_bmad/bme/_vortex/guides/MAX-USER-GUIDE.md)
|
|
207
|
+
## Extending Convoke
|
|
264
208
|
|
|
265
|
-
|
|
209
|
+
### Team Factory
|
|
266
210
|
|
|
267
|
-
|
|
211
|
+
Create fully-wired, BMAD-compliant teams through a guided workflow — zero post-creation fixes.
|
|
268
212
|
|
|
269
|
-
|
|
213
|
+
```
|
|
214
|
+
/bmad-team-factory
|
|
215
|
+
```
|
|
270
216
|
|
|
271
|
-
|
|
272
|
-
[](_bmad/bme/_enhance/workflows/initiatives-backlog/workflow.md)
|
|
217
|
+
The factory guides you through composition pattern selection (Independent or Sequential), agent scope definition with overlap detection, contract design, and integration wiring. Decision state is persisted as a spec file for resume and express mode. Output passes the same validation as native teams.
|
|
273
218
|
|
|
274
|
-
|
|
219
|
+
Three capabilities:
|
|
220
|
+
- **Create Team** — build a new team from scratch with full integration
|
|
221
|
+
- **Add Agent** — extend an existing team with a new agent
|
|
222
|
+
- **Add Skill** — give an existing agent a new workflow
|
|
275
223
|
|
|
276
|
-
###
|
|
224
|
+
### Enhance — Agent Skills
|
|
277
225
|
|
|
278
|
-
The first
|
|
226
|
+
Skills give existing agents new workflows — installed via menu patching, not agent modification. The first skill adds RICE-scored backlog management to the PM agent:
|
|
279
227
|
|
|
280
228
|
```
|
|
281
229
|
Initiatives Backlog
|
|
282
230
|
|
|
283
231
|
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
284
232
|
│ [T] Triage │ │ [R] Review │ │ [C] Create │
|
|
285
|
-
│ Ingest new │ │ Rescore │ │ Bootstrap
|
|
286
|
-
│ findings │ │ existing │ │
|
|
233
|
+
│ Ingest new │ │ Rescore │ │ Bootstrap │
|
|
234
|
+
│ findings │ │ existing │ │ from scratch│
|
|
287
235
|
└──────┬──────┘ └──────┬──────┘ └──────┬──────┘
|
|
288
236
|
│ │ │
|
|
289
237
|
▼ ▼ ▼
|
|
290
238
|
┌──────────────────────────────────────────────────┐
|
|
291
|
-
│ initiatives-backlog.md
|
|
239
|
+
│ initiatives-backlog.md │
|
|
292
240
|
│ RICE-scored · Categorized · Change-tracked │
|
|
293
241
|
└──────────────────────────────────────────────────┘
|
|
294
242
|
```
|
|
295
243
|
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
244
|
+
Activate from the PM agent menu or directly: `/bmad-enhance-initiatives-backlog`
|
|
245
|
+
|
|
246
|
+
The [Enhance Guide](_bmad/bme/_enhance/guides/ENHANCE-GUIDE.md) documents the complete pattern for building your own skills.
|
|
247
|
+
|
|
248
|
+
---
|
|
249
|
+
|
|
250
|
+
## Quick Start
|
|
251
|
+
|
|
252
|
+
### Prerequisites
|
|
253
|
+
|
|
254
|
+
- Node.js 18+ or Bun
|
|
255
|
+
- Git
|
|
256
|
+
- Claude Code or Claude.ai
|
|
257
|
+
|
|
258
|
+
### Install
|
|
301
259
|
|
|
302
|
-
|
|
260
|
+
**Everything (Vortex + Gyre):**
|
|
303
261
|
|
|
304
|
-
|
|
262
|
+
```bash
|
|
263
|
+
npm install convoke-agents && npx -p convoke-agents convoke-install
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
**Vortex only:**
|
|
305
267
|
|
|
268
|
+
```bash
|
|
269
|
+
npm install convoke-agents && npx -p convoke-agents convoke-install-vortex
|
|
306
270
|
```
|
|
307
|
-
|
|
271
|
+
|
|
272
|
+
**Gyre only:**
|
|
273
|
+
|
|
274
|
+
```bash
|
|
275
|
+
npm install convoke-agents && npx -p convoke-agents convoke-install-gyre
|
|
308
276
|
```
|
|
309
277
|
|
|
310
|
-
|
|
278
|
+
Something not working? Run `npx -p convoke-agents convoke-doctor` or check the [FAQ](docs/faq.md).
|
|
279
|
+
|
|
280
|
+
### Personalize
|
|
281
|
+
|
|
282
|
+
Open `_bmad/bme/_vortex/config.yaml` (or `_bmad/bme/_gyre/config.yaml`) and replace `{user}` with your name. Agents use this to personalize their interactions.
|
|
283
|
+
|
|
284
|
+
### Activate an Agent
|
|
311
285
|
|
|
312
286
|
**Claude Code (skills)**
|
|
287
|
+
|
|
313
288
|
```
|
|
314
|
-
|
|
289
|
+
# Vortex
|
|
290
|
+
/bmad-agent-bme-contextualization-expert # Emma 🎯
|
|
291
|
+
/bmad-agent-bme-discovery-empathy-expert # Isla 🔍
|
|
292
|
+
/bmad-agent-bme-research-convergence-specialist # Mila 🔬
|
|
293
|
+
/bmad-agent-bme-hypothesis-engineer # Liam 💡
|
|
294
|
+
/bmad-agent-bme-lean-experiments-specialist # Wade 🧪
|
|
295
|
+
/bmad-agent-bme-production-intelligence-specialist # Noah 📡
|
|
296
|
+
/bmad-agent-bme-learning-decision-expert # Max 🧭
|
|
297
|
+
|
|
298
|
+
# Gyre
|
|
299
|
+
/bmad-agent-bme-stack-detective # Scout 🔎
|
|
300
|
+
/bmad-agent-bme-model-curator # Atlas 📐
|
|
301
|
+
/bmad-agent-bme-readiness-analyst # Lens 🔬
|
|
302
|
+
/bmad-agent-bme-review-coach # Coach 🏋️
|
|
315
303
|
```
|
|
316
304
|
|
|
317
305
|
**Claude Code (terminal) / Other AI assistants**
|
|
306
|
+
|
|
318
307
|
```bash
|
|
319
|
-
|
|
308
|
+
# Vortex
|
|
309
|
+
cat _bmad/bme/_vortex/agents/contextualization-expert.md # Emma 🎯
|
|
310
|
+
# ... (see user guides for full list)
|
|
311
|
+
|
|
312
|
+
# Gyre
|
|
313
|
+
cat _bmad/bme/_gyre/agents/stack-detective.md # Scout 🔎
|
|
314
|
+
cat _bmad/bme/_gyre/agents/model-curator.md # Atlas 📐
|
|
315
|
+
cat _bmad/bme/_gyre/agents/readiness-analyst.md # Lens 🔬
|
|
316
|
+
cat _bmad/bme/_gyre/agents/review-coach.md # Coach 🏋️
|
|
320
317
|
```
|
|
321
318
|
|
|
322
|
-
|
|
319
|
+
**Claude.ai** — Open any agent file and paste its contents into your conversation.
|
|
320
|
+
|
|
321
|
+
**How activation works:** Each agent is a markdown file containing a full persona, menu system, and workflow instructions. When Claude reads the file, it adopts that agent's expertise and presents you with an interactive menu. Pick a workflow from the menu and follow the guided steps.
|
|
322
|
+
|
|
323
|
+
### Your First 15 Minutes
|
|
324
|
+
|
|
325
|
+
1. **Personalize** — edit the config.yaml for your chosen team and replace `{user}` with your name
|
|
326
|
+
2. **Pick a starting point:**
|
|
327
|
+
- **Vortex:** Activate Emma → select **Lean Persona** from the menu → follow the guided steps
|
|
328
|
+
- **Gyre:** Activate Scout → select **Full Analysis** from the menu → walk through the pipeline
|
|
329
|
+
3. **Find your artifact** — outputs are saved in `_bmad-output/vortex-artifacts/` or `.gyre/`
|
|
330
|
+
4. **Follow the Compass** — each workflow ends with a routing suggestion for which agent to use next
|
|
323
331
|
|
|
324
|
-
|
|
332
|
+
### What Gets Installed
|
|
325
333
|
|
|
326
|
-
|
|
334
|
+
```
|
|
335
|
+
your-project/
|
|
336
|
+
├── _bmad/bme/
|
|
337
|
+
│ ├── _vortex/ # Team: Product Discovery
|
|
338
|
+
│ │ ├── agents/ # 7 agent definition files
|
|
339
|
+
│ │ ├── workflows/ # 22 workflows
|
|
340
|
+
│ │ ├── contracts/ # Handoff contracts (HC1-HC5 artifact, HC6-HC10 routing)
|
|
341
|
+
│ │ ├── guides/ # User guides (all 7 agents)
|
|
342
|
+
│ │ └── config.yaml # Configuration
|
|
343
|
+
│ ├── _gyre/ # Team: Production Readiness
|
|
344
|
+
│ │ ├── agents/ # 4 agent definition files
|
|
345
|
+
│ │ ├── workflows/ # 7 workflows
|
|
346
|
+
│ │ ├── contracts/ # Artifact contract schemas (GC1-GC4)
|
|
347
|
+
│ │ ├── guides/ # User guides (all 4 agents)
|
|
348
|
+
│ │ └── config.yaml # Configuration
|
|
349
|
+
│ └── _enhance/ # Skill: Agent Capability Upgrades
|
|
350
|
+
│ ├── workflows/ # Skill workflows (initiatives-backlog)
|
|
351
|
+
│ ├── extensions/ # Agent menu patch descriptors
|
|
352
|
+
│ ├── guides/ # Module author guide
|
|
353
|
+
│ └── config.yaml # Configuration
|
|
354
|
+
└── _bmad-output/
|
|
355
|
+
├── vortex-artifacts/ # Vortex generated artifacts
|
|
356
|
+
└── gyre-artifacts/ # Gyre generated artifacts
|
|
357
|
+
```
|
|
327
358
|
|
|
328
359
|
---
|
|
329
360
|
|
|
330
361
|
## How It Fits with BMAD Core
|
|
331
362
|
|
|
332
|
-
Convoke handles **discovery and
|
|
363
|
+
Convoke handles **discovery, validation, and readiness**. BMAD Core handles **implementation**.
|
|
333
364
|
|
|
334
365
|
```
|
|
335
366
|
Convoke Modules BMAD Core
|
|
336
367
|
┌──────────────────────────────┐ ┌──────────────────────┐
|
|
337
368
|
│ Teams │ │ │
|
|
338
369
|
│ Vortex (Product Discovery) │ ──────> │ PM → Architect → Dev │
|
|
339
|
-
│
|
|
340
|
-
│ │
|
|
370
|
+
│ Gyre (Prod. Readiness) │ <────── │ "Let's build it" │
|
|
371
|
+
│ │ │ │
|
|
341
372
|
│ Skills │ signals │ │
|
|
342
373
|
│ Enhance (Agent Upgrades) │ ──────> │ │
|
|
343
|
-
│
|
|
374
|
+
│ │ │ │
|
|
344
375
|
└──────────────────────────────┘ └──────────────────────┘
|
|
345
376
|
```
|
|
346
377
|
|
|
@@ -348,11 +379,32 @@ Teams and Skills are peer module types — both installable, both independent. C
|
|
|
348
379
|
|
|
349
380
|
---
|
|
350
381
|
|
|
382
|
+
## Updating
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
npx -p convoke-agents convoke-version # Check current version
|
|
386
|
+
npx -p convoke-agents convoke-update --dry-run # Preview changes
|
|
387
|
+
npx -p convoke-agents convoke-update # Apply update (auto-backup)
|
|
388
|
+
npx -p convoke-agents convoke-doctor # Diagnose issues
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
Your data in `_bmad-output/` and `.gyre/` is never touched. Automatic backups are created before every update.
|
|
392
|
+
|
|
393
|
+
> **Tip:** If `npx convoke-update` reports "Already up to date" but you know a newer version exists, npx may be serving a cached copy. Force the latest with:
|
|
394
|
+
> ```bash
|
|
395
|
+
> npx -p convoke-agents@latest convoke-update --yes
|
|
396
|
+
> ```
|
|
397
|
+
|
|
398
|
+
See [UPDATE-GUIDE.md](UPDATE-GUIDE.md) for migration paths and troubleshooting.
|
|
399
|
+
|
|
400
|
+
---
|
|
401
|
+
|
|
351
402
|
## Documentation
|
|
352
403
|
|
|
353
404
|
| Document | Description |
|
|
354
405
|
|----------|-------------|
|
|
355
406
|
| [Agent Guide](docs/agents.md) | Detailed agent descriptions, workflows, and positioning |
|
|
407
|
+
| [BMAD Compatibility](docs/BMAD-METHOD-COMPATIBILITY.md) | Compatibility matrix with BMAD Method versions |
|
|
356
408
|
| [Testing](docs/testing.md) | Automated test suite, CI pipeline, and agent test results |
|
|
357
409
|
| [Development Guide](docs/development.md) | Architecture, building agents, and contributing |
|
|
358
410
|
| [FAQ](docs/faq.md) | Common questions about the framework |
|
|
@@ -363,12 +415,11 @@ Teams and Skills are peer module types — both installable, both independent. C
|
|
|
363
415
|
|
|
364
416
|
## Roadmap
|
|
365
417
|
|
|
366
|
-
- **v1.
|
|
367
|
-
- **
|
|
368
|
-
- **
|
|
369
|
-
- **
|
|
370
|
-
- **
|
|
371
|
-
- **Next** — Additional teams, additional skills, multi-agent collaboration, cross-module workflows
|
|
418
|
+
- **v1.x** — Vortex foundation: 7 agents, 22 workflows, update system, CI/CD
|
|
419
|
+
- **v2.0** — Product renamed to Convoke. CLI commands: `convoke-*`. Package: `convoke-agents`
|
|
420
|
+
- **v2.x** — Enhance module (Skills architecture, RICE initiatives-backlog), Gyre team (production readiness, 4 agents), Team Factory
|
|
421
|
+
- **Next** — Forge (domain knowledge extraction for enterprise brownfield engagements)
|
|
422
|
+
- **Future** — Additional teams, Forge-Gyre integration, cross-team workflows
|
|
372
423
|
|
|
373
424
|
---
|
|
374
425
|
|
|
@@ -377,11 +428,11 @@ Teams and Skills are peer module types — both installable, both independent. C
|
|
|
377
428
|
We welcome contributions in these areas:
|
|
378
429
|
|
|
379
430
|
- **Agents** — New domain-specialized agents, workflow improvements
|
|
431
|
+
- **Teams** — New team modules via the Team Factory
|
|
380
432
|
- **Testing** — Edge cases, performance testing
|
|
381
433
|
- **Documentation** — Tutorials, translations, video walkthroughs
|
|
382
|
-
- **Integration** — IDE plugins, third-party tools
|
|
383
434
|
|
|
384
|
-
**Have feedback?** Found a quality issue, want a missing capability, or have a general comment about an agent? Open an issue and select the **Agent/Workflow Feedback** template
|
|
435
|
+
**Have feedback?** Found a quality issue, want a missing capability, or have a general comment about an agent? Open an issue and select the **Agent/Workflow Feedback** template.
|
|
385
436
|
|
|
386
437
|
See the [Development Guide](docs/development.md) for architecture details and agent development patterns.
|
|
387
438
|
|
|
@@ -424,6 +475,12 @@ Every agent below contributed to the design, implementation, testing, or documen
|
|
|
424
475
|
- Noah 📡 Sensitize — Production intelligence and signal interpretation
|
|
425
476
|
- Max 🧭 Systematize — Learning capture and pivot/persevere decisions
|
|
426
477
|
|
|
478
|
+
**BME — Gyre Pattern Agents**
|
|
479
|
+
- Scout 🔎 Stack Detective — Technology stack detection and classification
|
|
480
|
+
- Atlas 📐 Model Curator — Contextual capabilities manifest generation
|
|
481
|
+
- Lens 🔬 Readiness Analyst — Absence detection and cross-domain correlation
|
|
482
|
+
- Coach 🏋️ Review Coach — Guided review, amendment, and feedback capture
|
|
483
|
+
|
|
427
484
|
**CIS — Creative & Innovation Strategies**
|
|
428
485
|
- Carson 🧠 Brainstorming Coach — Creative ideation facilitation
|
|
429
486
|
- Dr. Quinn 🔬 Problem Solver — Systematic problem-solving
|
|
@@ -444,7 +501,7 @@ Every agent below contributed to the design, implementation, testing, or documen
|
|
|
444
501
|
|
|
445
502
|
<div align="center">
|
|
446
503
|
|
|
447
|
-
**
|
|
504
|
+
**Discover what has to be discovered. Ship what's ready to ship.**
|
|
448
505
|
|
|
449
506
|
[Get Started](#quick-start) | [Agents](docs/agents.md) | [Docs](#documentation) | [Roadmap](#roadmap)
|
|
450
507
|
|