agileflow 2.33.1 → 2.35.0
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/LICENSE +22 -0
- package/README.md +536 -0
- package/package.json +1 -1
- package/src/core/agents/adr-writer.md +3 -19
- package/src/core/agents/api.md +9 -43
- package/src/core/agents/ci.md +8 -40
- package/src/core/agents/configuration/archival.md +301 -0
- package/src/core/agents/configuration/attribution.md +318 -0
- package/src/core/agents/configuration/ci.md +1077 -0
- package/src/core/agents/configuration/git-config.md +511 -0
- package/src/core/agents/configuration/hooks.md +507 -0
- package/src/core/agents/configuration/verify.md +540 -0
- package/src/core/agents/devops.md +7 -35
- package/src/core/agents/documentation.md +0 -1
- package/src/core/agents/epic-planner.md +3 -22
- package/src/core/agents/mentor.md +8 -24
- package/src/core/agents/research.md +0 -7
- package/src/core/agents/security.md +0 -5
- package/src/core/agents/ui.md +8 -42
- package/src/core/commands/PATTERNS-AskUserQuestion.md +474 -0
- package/src/core/commands/adr.md +5 -0
- package/src/core/commands/agent.md +4 -0
- package/src/core/commands/assign.md +1 -0
- package/src/core/commands/auto.md +1 -1
- package/src/core/commands/babysit.md +147 -31
- package/src/core/commands/baseline.md +7 -0
- package/src/core/commands/blockers.md +2 -0
- package/src/core/commands/board.md +9 -0
- package/src/core/commands/configure.md +415 -0
- package/src/core/commands/context.md +1 -0
- package/src/core/commands/deps.md +2 -0
- package/src/core/commands/diagnose.md +0 -41
- package/src/core/commands/epic.md +8 -0
- package/src/core/commands/handoff.md +4 -0
- package/src/core/commands/impact.md +1 -1
- package/src/core/commands/metrics.md +10 -0
- package/src/core/commands/research.md +3 -0
- package/src/core/commands/retro.md +11 -1
- package/src/core/commands/sprint.md +2 -1
- package/src/core/commands/status.md +1 -0
- package/src/core/commands/story-validate.md +1 -1
- package/src/core/commands/story.md +29 -2
- package/src/core/commands/template.md +8 -0
- package/src/core/commands/update.md +1 -1
- package/src/core/commands/velocity.md +9 -0
- package/src/core/commands/verify.md +6 -0
- package/src/core/templates/validate-tokens.sh +0 -15
- package/src/core/templates/worktrees-guide.md +0 -4
- package/tools/agileflow-npx.js +21 -9
- package/tools/cli/commands/config.js +284 -0
- package/tools/cli/commands/doctor.js +221 -4
- package/tools/cli/commands/setup.js +4 -1
- package/tools/cli/commands/update.js +59 -15
- package/tools/cli/installers/core/installer.js +369 -37
- package/tools/cli/installers/ide/claude-code.js +1 -1
- package/tools/cli/installers/ide/cursor.js +1 -1
- package/tools/cli/installers/ide/windsurf.js +1 -1
- package/tools/cli/lib/docs-setup.js +52 -28
- package/tools/cli/lib/npm-utils.js +62 -0
- package/tools/cli/lib/ui.js +9 -2
- package/tools/postinstall.js +71 -13
- package/src/core/agents/context7.md +0 -164
- package/src/core/commands/setup.md +0 -708
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 AgileFlow Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,536 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="assets/banner.png" alt="AgileFlow" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/agileflow)
|
|
6
|
+
[](#commands)
|
|
7
|
+
[](SUBAGENTS.md)
|
|
8
|
+
[](#skills)
|
|
9
|
+
|
|
10
|
+
**AI-driven agile development for Claude Code, Cursor, Windsurf, and more.** Combining Scrum, Kanban, ADRs, and docs-as-code principles into one framework-agnostic system.
|
|
11
|
+
|
|
12
|
+
## Quick Start
|
|
13
|
+
|
|
14
|
+
### Installation
|
|
15
|
+
|
|
16
|
+
#### Option 1: Global Installation (Recommended)
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install -g agileflow
|
|
20
|
+
agileflow setup
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
#### Option 2: Project-Level Installation
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install agileflow
|
|
27
|
+
npx agileflow setup
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
This will:
|
|
31
|
+
1. Prompt where to install AgileFlow
|
|
32
|
+
2. Prompt to select your IDE(s)
|
|
33
|
+
3. Install AgileFlow core (commands, agents, skills)
|
|
34
|
+
4. Configure your selected IDEs
|
|
35
|
+
5. Create documentation structure
|
|
36
|
+
|
|
37
|
+
### CLI Commands
|
|
38
|
+
|
|
39
|
+
**Global installation:**
|
|
40
|
+
```bash
|
|
41
|
+
agileflow setup # Set up AgileFlow in project
|
|
42
|
+
agileflow status # Check installation + updates
|
|
43
|
+
agileflow update # Update to latest version
|
|
44
|
+
agileflow doctor # Diagnose issues
|
|
45
|
+
agileflow uninstall # Remove from project
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Project-level installation (use `npx`):**
|
|
49
|
+
```bash
|
|
50
|
+
npx agileflow setup # Set up AgileFlow in project
|
|
51
|
+
npx agileflow status # Check installation + updates
|
|
52
|
+
npx agileflow update # Update to latest version
|
|
53
|
+
npx agileflow doctor # Diagnose issues
|
|
54
|
+
npx agileflow uninstall # Remove from project
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### After Setup
|
|
58
|
+
|
|
59
|
+
**Initialize the system:**
|
|
60
|
+
```
|
|
61
|
+
/AgileFlow:setup
|
|
62
|
+
```
|
|
63
|
+
Scaffolds docs structure, templates, and optional CI configuration.
|
|
64
|
+
|
|
65
|
+
**Get help:**
|
|
66
|
+
```
|
|
67
|
+
/AgileFlow:help
|
|
68
|
+
```
|
|
69
|
+
View system overview and available commands.
|
|
70
|
+
|
|
71
|
+
**Use the mentor (recommended):**
|
|
72
|
+
```
|
|
73
|
+
Use the mentor subagent to guide me through implementing <feature>
|
|
74
|
+
```
|
|
75
|
+
Interactive mentor guides you through epic/story creation, implementation, and PR preparation.
|
|
76
|
+
|
|
77
|
+
### Supported IDEs
|
|
78
|
+
|
|
79
|
+
| IDE | Status | Config Location |
|
|
80
|
+
|-----|--------|-----------------|
|
|
81
|
+
| Claude Code | ✅ Supported | `.claude/commands/AgileFlow/` |
|
|
82
|
+
| Cursor | ✅ Supported | `.cursor/rules/agileflow/` |
|
|
83
|
+
| Windsurf | ✅ Supported | `.windsurf/workflows/agileflow/` |
|
|
84
|
+
|
|
85
|
+
## Why AgileFlow?
|
|
86
|
+
|
|
87
|
+
AgileFlow combines three proven methodologies:
|
|
88
|
+
|
|
89
|
+
- **Agile (Scrum/Kanban)** - Break work into Epics → Stories → Acceptance Criteria with WIP limits
|
|
90
|
+
- **ADRs** - Record architectural decisions so future teams don't re-debate
|
|
91
|
+
- **Docs-as-Code** - Humans and AI agents coordinate via versioned files (traceable, reviewable, automatable)
|
|
92
|
+
|
|
93
|
+
**Key Benefits:**
|
|
94
|
+
- Clear priorities and testable increments
|
|
95
|
+
- Durable memory and decision history
|
|
96
|
+
- Effortless multi-agent collaboration via message bus
|
|
97
|
+
- Works with any tech stack or framework
|
|
98
|
+
|
|
99
|
+
<details>
|
|
100
|
+
<summary><strong>📁 Folder Structure</strong> (click to expand)</summary>
|
|
101
|
+
|
|
102
|
+
After running `/AgileFlow:setup`:
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
docs/
|
|
106
|
+
00-meta/ # Templates, glossary, conventions
|
|
107
|
+
01-brainstorming/ # Ideas and sketches
|
|
108
|
+
02-practices/ # Testing, git, CI, security practices
|
|
109
|
+
prompts/agents/ # Agent profiles and contracts
|
|
110
|
+
03-decisions/ # ADRs (Architecture Decision Records)
|
|
111
|
+
04-architecture/ # Architecture documentation
|
|
112
|
+
05-epics/ # Epic definitions
|
|
113
|
+
06-stories/ # User stories (grouped by epic)
|
|
114
|
+
07-testing/ # Test cases and acceptance criteria
|
|
115
|
+
08-project/ # Roadmap, backlog, milestones, risks
|
|
116
|
+
09-agents/ # Agent status and message bus
|
|
117
|
+
bus/log.jsonl # Agent communication log
|
|
118
|
+
status.json # Current story statuses
|
|
119
|
+
10-research/ # Saved research notes
|
|
120
|
+
context.md # One-page context brief for web AI tools
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
</details>
|
|
124
|
+
|
|
125
|
+
<details>
|
|
126
|
+
<summary><strong>📚 Commands</strong> (41 total - click to expand)</summary>
|
|
127
|
+
|
|
128
|
+
### Core Workflow
|
|
129
|
+
- `/AgileFlow:setup` - Bootstrap the entire system
|
|
130
|
+
- `/AgileFlow:help` - Display system overview
|
|
131
|
+
- `/AgileFlow:babysit` - Interactive mentor for end-to-end implementation
|
|
132
|
+
|
|
133
|
+
### Planning & Structure
|
|
134
|
+
- `/AgileFlow:epic` - Create a new epic
|
|
135
|
+
- `/AgileFlow:story` - Create a user story with acceptance criteria
|
|
136
|
+
- `/AgileFlow:story-validate` - Validate story completeness before development
|
|
137
|
+
- `/AgileFlow:sprint` - Data-driven sprint planning with velocity forecasting
|
|
138
|
+
- `/AgileFlow:adr` - Create an Architecture Decision Record
|
|
139
|
+
- `/AgileFlow:agent` - Onboard a new agent
|
|
140
|
+
|
|
141
|
+
### Task Management
|
|
142
|
+
- `/AgileFlow:assign` - Assign/reassign a story
|
|
143
|
+
- `/AgileFlow:status` - Update story status
|
|
144
|
+
- `/AgileFlow:handoff` - Document handoff between agents
|
|
145
|
+
|
|
146
|
+
### Quality & CI
|
|
147
|
+
- `/AgileFlow:pr` - Generate PR description
|
|
148
|
+
- `/AgileFlow:ci` - Bootstrap CI workflow
|
|
149
|
+
- `/AgileFlow:readme-sync` - Sync folder READMEs
|
|
150
|
+
- `/AgileFlow:tests` - Automated testing infrastructure setup
|
|
151
|
+
- `/AgileFlow:review` - AI-powered code review
|
|
152
|
+
- `/AgileFlow:verify` - Run tests and update story test status (Session Harness)
|
|
153
|
+
- `/AgileFlow:session-init` - Initialize session harness with test verification (Phase 2)
|
|
154
|
+
- `/AgileFlow:resume` - Resume session with environment verification and context (Phase 2)
|
|
155
|
+
- `/AgileFlow:baseline` - Mark current state as verified baseline (Phase 2)
|
|
156
|
+
- `/AgileFlow:compress` - Compress status.json (fixes token limit issues)
|
|
157
|
+
|
|
158
|
+
### Automation & DevOps
|
|
159
|
+
- `/AgileFlow:packages` - Manage dependencies (dashboard, updates, security audits)
|
|
160
|
+
- `/AgileFlow:docs` - Synchronize docs with code changes
|
|
161
|
+
- `/AgileFlow:impact` - Analyze change impact on codebase
|
|
162
|
+
- `/AgileFlow:debt` - Track and prioritize technical debt
|
|
163
|
+
- `/AgileFlow:deploy` - Automated deployment pipeline setup
|
|
164
|
+
- `/AgileFlow:changelog` - Auto-generate changelog from commits
|
|
165
|
+
- `/AgileFlow:auto` - Generate stories from PRDs/mockups/specs
|
|
166
|
+
- `/AgileFlow:template` - Create and manage custom templates
|
|
167
|
+
- `/AgileFlow:feedback` - Collect feedback for continuous improvement
|
|
168
|
+
- `/AgileFlow:update` - Generate stakeholder reports
|
|
169
|
+
|
|
170
|
+
### Visualization & Analytics
|
|
171
|
+
- `/AgileFlow:board` - Visual kanban board with WIP limits
|
|
172
|
+
- `/AgileFlow:blockers` - Comprehensive blocker tracking with resolution suggestions
|
|
173
|
+
- `/AgileFlow:velocity` - Velocity tracking and forecasting
|
|
174
|
+
- `/AgileFlow:metrics` - Analytics dashboard (cycle time, lead time, throughput, flow efficiency)
|
|
175
|
+
- `/AgileFlow:retro` - Automated retrospective generator with insights
|
|
176
|
+
- `/AgileFlow:deps` - Dependency graph visualization with critical path detection
|
|
177
|
+
|
|
178
|
+
### Web AI Integration
|
|
179
|
+
- `/AgileFlow:context` - Generate/export/manage context for web AI tools (ChatGPT, Perplexity, Gemini, Claude, etc.)
|
|
180
|
+
- `/AgileFlow:research` - Save research notes
|
|
181
|
+
|
|
182
|
+
</details>
|
|
183
|
+
|
|
184
|
+
<details>
|
|
185
|
+
<summary><strong>🤖 Subagents</strong> (26 specialized agents - click to expand)</summary>
|
|
186
|
+
|
|
187
|
+
AgileFlow includes **26 specialized subagents** that operate in separate context windows for focused work. See [SUBAGENTS.md](SUBAGENTS.md) for complete documentation.
|
|
188
|
+
|
|
189
|
+
### Core Implementation Agents
|
|
190
|
+
|
|
191
|
+
**`ui`** - UI/Presentation Layer Specialist
|
|
192
|
+
- Front-end components, styling, theming, accessibility (WCAG 2.1 AA)
|
|
193
|
+
- Invocation: "Use the ui subagent to implement this UI feature"
|
|
194
|
+
|
|
195
|
+
**`api`** - Services/Data Layer Specialist
|
|
196
|
+
- Backend APIs, business logic, data models, API tests
|
|
197
|
+
- Invocation: "Use the api subagent to implement this API endpoint"
|
|
198
|
+
|
|
199
|
+
**`ci`** - CI/CD & Quality Specialist
|
|
200
|
+
- CI/CD pipelines, linting, type checking, test coverage
|
|
201
|
+
- Invocation: "Use the ci subagent to set up the test pipeline"
|
|
202
|
+
|
|
203
|
+
### Orchestration & Planning Agents
|
|
204
|
+
|
|
205
|
+
**`mentor`** - End-to-End Implementation Mentor
|
|
206
|
+
- Guides feature implementation from idea to PR
|
|
207
|
+
- Invocation: "Use the mentor subagent to guide me through this feature"
|
|
208
|
+
|
|
209
|
+
**`epic-planner`** - Epic & Story Planning Specialist
|
|
210
|
+
- Breaks down features into epics and stories with acceptance criteria
|
|
211
|
+
- Invocation: "Use the epic-planner subagent to plan this feature"
|
|
212
|
+
|
|
213
|
+
**`adr-writer`** - Architecture Decision Record Specialist
|
|
214
|
+
- Documents technical decisions, trade-offs, alternatives
|
|
215
|
+
- Invocation: "Use the adr-writer subagent to document this decision"
|
|
216
|
+
|
|
217
|
+
**`research`** - Research & Knowledge Management Specialist
|
|
218
|
+
- Conducts technical research, builds research prompts, saves notes
|
|
219
|
+
- Invocation: "Use the research subagent to research authentication approaches"
|
|
220
|
+
|
|
221
|
+
### Additional Specialized Agents
|
|
222
|
+
- `devops` - DevOps & Automation
|
|
223
|
+
- `security` - Security & Compliance
|
|
224
|
+
- `database` - Database & Data Layer
|
|
225
|
+
- `testing` - Testing & QA Automation
|
|
226
|
+
- `product` - Product Management & Prioritization
|
|
227
|
+
- `performance` - Performance Optimization
|
|
228
|
+
- `mobile` - Mobile Development
|
|
229
|
+
- `integrations` - Third-Party Integrations
|
|
230
|
+
- `refactor` - Code Refactoring & Technical Debt
|
|
231
|
+
- `design` - Design Systems & UI/UX
|
|
232
|
+
- `accessibility` - Accessibility Compliance (WCAG)
|
|
233
|
+
- `analytics` - Analytics & Metrics Implementation
|
|
234
|
+
- `datamigration` - Data Migration & ETL
|
|
235
|
+
- `qa` - Quality Assurance & Test Planning
|
|
236
|
+
- And more...
|
|
237
|
+
|
|
238
|
+
**When to Use Subagents:**
|
|
239
|
+
- Complex, multi-step implementation work
|
|
240
|
+
- Specialized tasks requiring focused expertise
|
|
241
|
+
- Work benefiting from separate context
|
|
242
|
+
- Tasks needing to run commands or write code
|
|
243
|
+
|
|
244
|
+
**When to Use Commands:**
|
|
245
|
+
- Quick, single-purpose actions
|
|
246
|
+
- Status updates and assignments
|
|
247
|
+
- Generating templates or prompts
|
|
248
|
+
- Simple file operations
|
|
249
|
+
|
|
250
|
+
</details>
|
|
251
|
+
|
|
252
|
+
<details>
|
|
253
|
+
<summary><strong>🎯 Skills</strong> (23 auto-loaded skills - click to expand)</summary>
|
|
254
|
+
|
|
255
|
+
Skills are **context-aware helpers** that activate automatically based on keywords (no manual invocation needed).
|
|
256
|
+
|
|
257
|
+
### How Skills Work
|
|
258
|
+
- **Activation:** Automatic (keyword-based detection)
|
|
259
|
+
- **Context:** Main conversation
|
|
260
|
+
- **Purpose:** Quick enhancements and formatting
|
|
261
|
+
- **Structure:** Follow Anthropic's minimal specification (v2.21.0+)
|
|
262
|
+
|
|
263
|
+
### Skills by Category
|
|
264
|
+
|
|
265
|
+
#### AgileFlow Skills (8 skills)
|
|
266
|
+
Auto-formatted outputs following AgileFlow templates:
|
|
267
|
+
- `agileflow-story-writer` - Converts discussions to user stories
|
|
268
|
+
- `agileflow-acceptance-criteria` - Generates Given/When/Then AC
|
|
269
|
+
- `epic-planner` - Breaks features into epics/stories
|
|
270
|
+
- `agileflow-sprint-planner` - Plans sprints with velocity
|
|
271
|
+
- `agileflow-retro-facilitator` - Structures retrospectives
|
|
272
|
+
- `agileflow-adr` - Captures architectural decisions
|
|
273
|
+
- `agileflow-commit-messages` - Formats Conventional Commits
|
|
274
|
+
- `agileflow-tech-debt` - Tracks technical debt
|
|
275
|
+
|
|
276
|
+
#### Template Generators (15 skills)
|
|
277
|
+
Generate code templates and documentation:
|
|
278
|
+
- `story-skeleton` - Story template scaffolding
|
|
279
|
+
- `acceptance-criteria-generator` - AC formatting
|
|
280
|
+
- `commit-message-formatter` - Git commit messages
|
|
281
|
+
- `adr-template` - Architecture decision records
|
|
282
|
+
- `api-documentation-generator` - OpenAPI/Swagger docs
|
|
283
|
+
- `changelog-entry` - Keep a Changelog format
|
|
284
|
+
- `pr-description` - Pull request descriptions
|
|
285
|
+
- `test-case-generator` - Test cases from AC
|
|
286
|
+
- `type-definitions` - TypeScript interfaces
|
|
287
|
+
- `sql-schema-generator` - SQL schemas with migrations
|
|
288
|
+
- `error-handler-template` - Error handling patterns
|
|
289
|
+
- `diagram-generator` - Mermaid/ASCII diagrams
|
|
290
|
+
- `validation-schema-generator` - Joi/Zod/Yup schemas
|
|
291
|
+
- `deployment-guide-generator` - Deployment runbooks
|
|
292
|
+
- `migration-checklist` - Data migration checklists
|
|
293
|
+
|
|
294
|
+
### Example Activation
|
|
295
|
+
```
|
|
296
|
+
User: "I need to create a user story for login functionality"
|
|
297
|
+
[agileflow-story-writer skill activates automatically]
|
|
298
|
+
Claude: Generates formatted story with AC, owner, priority, estimate
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
</details>
|
|
302
|
+
|
|
303
|
+
<details>
|
|
304
|
+
<summary><strong>🎯 Hooks System</strong> (event-driven automation - click to expand)</summary>
|
|
305
|
+
|
|
306
|
+
AgileFlow supports **event-driven automation** through Claude Code's official hooks system.
|
|
307
|
+
|
|
308
|
+
### What Are Hooks?
|
|
309
|
+
|
|
310
|
+
Hooks are automatic triggers that execute commands in response to events:
|
|
311
|
+
- **SessionStart** - Runs when Claude Code session starts
|
|
312
|
+
- **UserPromptSubmit** - Runs after you submit a prompt
|
|
313
|
+
- **Stop** - Runs when Claude stops responding
|
|
314
|
+
|
|
315
|
+
### Quick Setup
|
|
316
|
+
|
|
317
|
+
1. **Create .claude directory:**
|
|
318
|
+
```bash
|
|
319
|
+
mkdir -p .claude
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
2. **Copy template:**
|
|
323
|
+
```bash
|
|
324
|
+
cp templates/claude-settings.example.json .claude/settings.json
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
3. **Customize hooks** (edit `.claude/settings.json`):
|
|
328
|
+
```json
|
|
329
|
+
{
|
|
330
|
+
"hooks": {
|
|
331
|
+
"SessionStart": [{
|
|
332
|
+
"hooks": [{
|
|
333
|
+
"type": "command",
|
|
334
|
+
"command": "echo '🚀 AgileFlow loaded - Type /AgileFlow:help'"
|
|
335
|
+
}]
|
|
336
|
+
}]
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
4. **Restart Claude Code**
|
|
342
|
+
|
|
343
|
+
### Example Use Cases
|
|
344
|
+
|
|
345
|
+
**Welcome message:**
|
|
346
|
+
```json
|
|
347
|
+
{
|
|
348
|
+
"SessionStart": [{
|
|
349
|
+
"hooks": [{
|
|
350
|
+
"type": "command",
|
|
351
|
+
"command": "echo '👋 Welcome! Current sprint: $(cat docs/08-project/current-sprint.txt)'"
|
|
352
|
+
}]
|
|
353
|
+
}]
|
|
354
|
+
}
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
**Activity logging:**
|
|
358
|
+
```json
|
|
359
|
+
{
|
|
360
|
+
"UserPromptSubmit": [{
|
|
361
|
+
"hooks": [{
|
|
362
|
+
"type": "command",
|
|
363
|
+
"command": "echo '[LOG] Prompt at $(date)' >> .claude/activity.log"
|
|
364
|
+
}]
|
|
365
|
+
}]
|
|
366
|
+
}
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Configuration Files
|
|
370
|
+
- `.claude/settings.json` - Project-level config (committed to git)
|
|
371
|
+
- `.claude/settings.local.json` - User-specific overrides (gitignored)
|
|
372
|
+
|
|
373
|
+
</details>
|
|
374
|
+
|
|
375
|
+
<details>
|
|
376
|
+
<summary><strong>🔧 Advanced Topics</strong> (click to expand)</summary>
|
|
377
|
+
|
|
378
|
+
### Daily Workflow
|
|
379
|
+
|
|
380
|
+
1. **Pick a story** - Use `mentor` or check `docs/09-agents/status.json`
|
|
381
|
+
2. **Implement to AC** - Follow acceptance criteria
|
|
382
|
+
3. **Write tests** - Reference `docs/07-testing/test-cases/<STORY_ID>.md`
|
|
383
|
+
4. **Update status** - Use `/AgileFlow:status`
|
|
384
|
+
5. **Create PR** - Use `/AgileFlow:pr`
|
|
385
|
+
6. **Mark done** - Update status after merge
|
|
386
|
+
|
|
387
|
+
### Multi-Agent Collaboration
|
|
388
|
+
|
|
389
|
+
AgileFlow uses a message bus (`docs/09-agents/bus/log.jsonl`) for coordination:
|
|
390
|
+
- Agents update `docs/09-agents/status.json` with current work
|
|
391
|
+
- Messages logged to bus for async communication
|
|
392
|
+
- Use `/AgileFlow:handoff` to transfer work between agents
|
|
393
|
+
- WIP limit: max 2 stories per agent
|
|
394
|
+
|
|
395
|
+
### Git Worktrees for Context Preservation
|
|
396
|
+
|
|
397
|
+
For advanced users handling urgent hotfixes during feature work:
|
|
398
|
+
|
|
399
|
+
**Benefits:**
|
|
400
|
+
- Preserve AI context when switching tasks
|
|
401
|
+
- Handle production bugs without losing feature flow
|
|
402
|
+
- Compare implementations side-by-side
|
|
403
|
+
- Test risky refactors in isolation
|
|
404
|
+
|
|
405
|
+
**Quick Start:**
|
|
406
|
+
```bash
|
|
407
|
+
# Use helper script (created by /AgileFlow:setup)
|
|
408
|
+
./docs/00-meta/scripts/worktree-create.sh auth-hotfix
|
|
409
|
+
|
|
410
|
+
# Open in new window
|
|
411
|
+
code ../myapp-auth-hotfix
|
|
412
|
+
/AgileFlow:babysit
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
See `docs/00-meta/guides/worktrees.md` for comprehensive guide.
|
|
416
|
+
|
|
417
|
+
### Web AI Integration
|
|
418
|
+
|
|
419
|
+
Share context with web AI tools (ChatGPT, Perplexity, Gemini, Claude, etc.):
|
|
420
|
+
|
|
421
|
+
1. Run `/AgileFlow:context` to generate/refresh context
|
|
422
|
+
2. Use `/AgileFlow:context MODE=export` for concise excerpt
|
|
423
|
+
3. Paste into web AI tool for research/ideation
|
|
424
|
+
4. Use `/AgileFlow:context MODE=research TOPIC="..."` for structured prompts
|
|
425
|
+
5. Save results with `/AgileFlow:research`
|
|
426
|
+
|
|
427
|
+
### Session Harness System (v2.24.0+)
|
|
428
|
+
|
|
429
|
+
Ensures test verification and session continuity for long-running projects. Prevents agents from breaking functionality and maintains progress across context windows.
|
|
430
|
+
|
|
431
|
+
**The Problem:**
|
|
432
|
+
Without verification, agents can:
|
|
433
|
+
- Break existing functionality without noticing
|
|
434
|
+
- Claim features work when tests fail
|
|
435
|
+
- Lose context between sessions
|
|
436
|
+
- Mark incomplete work as finished
|
|
437
|
+
|
|
438
|
+
**The Solution:**
|
|
439
|
+
Session Harness System tracks test status, verifies baselines, and maintains session state.
|
|
440
|
+
|
|
441
|
+
**Quick Start:**
|
|
442
|
+
```bash
|
|
443
|
+
# First time setup (interactive)
|
|
444
|
+
/AgileFlow:session-init
|
|
445
|
+
|
|
446
|
+
# Start each session (or auto-run via hook)
|
|
447
|
+
/AgileFlow:resume
|
|
448
|
+
|
|
449
|
+
# Run tests and update test status
|
|
450
|
+
/AgileFlow:verify
|
|
451
|
+
|
|
452
|
+
# Create verified checkpoint
|
|
453
|
+
/AgileFlow:baseline "Sprint 12 complete"
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
**How It Works:**
|
|
457
|
+
1. **Test Tracking**: Every story has `test_status` field (passing/failing/not_run)
|
|
458
|
+
2. **Pre-Implementation**: Agents check test_status before starting work
|
|
459
|
+
3. **Post-Implementation**: Agents run `/AgileFlow:verify` before marking complete
|
|
460
|
+
4. **Session Resume**: Loads context and detects regressions
|
|
461
|
+
5. **Baselines**: Git tags mark known-good states for reset points
|
|
462
|
+
|
|
463
|
+
**Benefits:**
|
|
464
|
+
- **No Broken Baselines**: Agents can't mark stories complete with failing tests
|
|
465
|
+
- **Fail Fast**: Catch regressions immediately, not at PR review
|
|
466
|
+
- **Context Continuity**: Structured handoff between sessions
|
|
467
|
+
- **Regression Detection**: Alerts when tests were passing, now failing
|
|
468
|
+
|
|
469
|
+
**Agent Integration (v2.26.0):**
|
|
470
|
+
All 18 dev agents now include verification protocol:
|
|
471
|
+
- ui, api, ci, devops
|
|
472
|
+
- security, database, testing
|
|
473
|
+
- performance, mobile, integrations
|
|
474
|
+
- refactor, design, accessibility
|
|
475
|
+
- analytics, datamigration, monitoring
|
|
476
|
+
- compliance, qa
|
|
477
|
+
|
|
478
|
+
**Learn More:** See CLAUDE.md "Session Harness System" section for complete documentation.
|
|
479
|
+
|
|
480
|
+
### Status.json Compression
|
|
481
|
+
|
|
482
|
+
Prevent "file too large" errors:
|
|
483
|
+
|
|
484
|
+
```bash
|
|
485
|
+
# Compress status.json (removes verbose fields)
|
|
486
|
+
/AgileFlow:compress
|
|
487
|
+
|
|
488
|
+
# Typical result: 80-90% size reduction
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
Full story content remains in `docs/06-stories/` markdown files (no data loss).
|
|
492
|
+
|
|
493
|
+
</details>
|
|
494
|
+
|
|
495
|
+
## Examples
|
|
496
|
+
|
|
497
|
+
### Creating an Epic with Stories
|
|
498
|
+
```
|
|
499
|
+
/AgileFlow:epic EPIC=EP-0001 TITLE="User Authentication" OWNER=AG-API GOAL="Secure user login and registration" STORIES="US-0001|Login form|AG-UI,US-0002|Auth API|AG-API"
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
### Working on a Story
|
|
503
|
+
```
|
|
504
|
+
/AgileFlow:assign STORY=US-0001 NEW_OWNER=AG-UI NEW_STATUS=in-progress NOTE="Starting implementation"
|
|
505
|
+
# ... do the work ...
|
|
506
|
+
/AgileFlow:status STORY=US-0001 STATUS=in-review SUMMARY="Login form complete with tests" PR=https://github.com/...
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
### Recording a Decision
|
|
510
|
+
```
|
|
511
|
+
/AgileFlow:adr NUMBER=0001 TITLE="Use JWT for authentication" CONTEXT="Need stateless auth for API" DECISION="JWT with 15min access + refresh tokens" CONSEQUENCES="Simpler scaling but requires token refresh flow"
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
## Templates
|
|
515
|
+
|
|
516
|
+
All templates are located in `templates/` and `docs/00-meta/templates/`:
|
|
517
|
+
|
|
518
|
+
- `epic-template.md` - Epic structure
|
|
519
|
+
- `story-template.md` - User story format
|
|
520
|
+
- `adr-template.md` - Architecture decision record
|
|
521
|
+
- `agent-profile-template.md` - Agent profile and contract
|
|
522
|
+
- `comms-note-template.md` - Handoff documentation
|
|
523
|
+
- `research-template.md` - Research note structure
|
|
524
|
+
- `README-template.md` - Folder README template
|
|
525
|
+
|
|
526
|
+
## Contributing
|
|
527
|
+
|
|
528
|
+
This plugin is designed to be framework-agnostic. Customize templates and commands to fit your team's workflow.
|
|
529
|
+
|
|
530
|
+
## License
|
|
531
|
+
|
|
532
|
+
MIT
|
|
533
|
+
|
|
534
|
+
## Support
|
|
535
|
+
|
|
536
|
+
For issues or questions, please visit the [GitHub repository](https://github.com/projectquestorg/AgileFlow).
|
package/package.json
CHANGED
|
@@ -71,10 +71,6 @@ SLASH COMMANDS (Proactive Use)
|
|
|
71
71
|
**Research**:
|
|
72
72
|
- `/AgileFlow:context MODE=research TOPIC=...` → Generate research for alternatives before writing ADR
|
|
73
73
|
|
|
74
|
-
**External Sync** (if enabled):
|
|
75
|
-
- `/AgileFlow:notion DATABASE=adrs` → Sync new ADR to Notion
|
|
76
|
-
- `/AgileFlow:github-sync` → Sync to GitHub
|
|
77
|
-
|
|
78
74
|
RESEARCH INTEGRATION
|
|
79
75
|
|
|
80
76
|
**Before Writing ADR**:
|
|
@@ -87,14 +83,6 @@ RESEARCH INTEGRATION
|
|
|
87
83
|
- Reference research note in ADR "References" section
|
|
88
84
|
- Link ADR back to research note
|
|
89
85
|
|
|
90
|
-
NOTION/GITHUB AUTO-SYNC (if enabled)
|
|
91
|
-
|
|
92
|
-
**Always sync after**:
|
|
93
|
-
- Creating new ADR → `/AgileFlow:notion DATABASE=adrs`
|
|
94
|
-
- Updating ADR status (Deprecated, Superseded) → Re-sync
|
|
95
|
-
|
|
96
|
-
**Why**: ADRs guide implementation. Stakeholders need visibility into architectural decisions.
|
|
97
|
-
|
|
98
86
|
WORKFLOW
|
|
99
87
|
1. **[KNOWLEDGE LOADING]** Before writing:
|
|
100
88
|
- Check docs/10-research/ for relevant research (or invoke `/AgileFlow:context MODE=research`)
|
|
@@ -114,10 +102,7 @@ WORKFLOW
|
|
|
114
102
|
5. Show preview (diff-first, YES/NO)
|
|
115
103
|
6. Create docs/03-decisions/adr-<NUMBER>-<slug>.md
|
|
116
104
|
7. Update docs/03-decisions/README.md (add entry to table)
|
|
117
|
-
8.
|
|
118
|
-
- Invoke `/AgileFlow:notion DATABASE=adrs` (if Notion enabled)
|
|
119
|
-
- Invoke `/AgileFlow:github-sync` (if GitHub enabled)
|
|
120
|
-
9. Notify user: "ADR-<NUMBER> created and synced to Notion/GitHub."
|
|
105
|
+
8. Notify user: "ADR-<NUMBER> created."
|
|
121
106
|
|
|
122
107
|
ADR TEMPLATE STRUCTURE
|
|
123
108
|
```markdown
|
|
@@ -197,14 +182,13 @@ FIRST ACTION
|
|
|
197
182
|
1. Read docs/03-decisions/README.md → Get next ADR number (sequential)
|
|
198
183
|
2. Check docs/10-research/ → Look for research supporting the decision
|
|
199
184
|
3. Scan recent ADRs → Identify related decisions
|
|
200
|
-
4. Check .mcp.json → Determine if Notion/GitHub sync is enabled
|
|
201
185
|
|
|
202
186
|
**Then Output**:
|
|
203
187
|
1. ADR context: "Next ADR: ADR-<NUMBER>, recent decisions: <list of last 3 ADRs>"
|
|
204
188
|
2. If research exists: "Found research: <topic> (docs/10-research/<file>)"
|
|
205
189
|
3. If no research: "No research found. I can invoke `/AgileFlow:context MODE=research` to gather alternatives."
|
|
206
190
|
4. Ask: "What technical decision would you like to document?"
|
|
207
|
-
5. Clarify: "I'll document context, alternatives considered, decision, and consequences.
|
|
191
|
+
5. Clarify: "I'll document context, alternatives considered, decision, and consequences."
|
|
208
192
|
|
|
209
193
|
**After User Describes Decision**:
|
|
210
194
|
1. Clarify context (why now? what forces?)
|
|
@@ -212,4 +196,4 @@ FIRST ACTION
|
|
|
212
196
|
3. Identify 2-5 alternatives with pros/cons
|
|
213
197
|
4. Propose ADR structure (show preview)
|
|
214
198
|
5. Get approval (YES/NO)
|
|
215
|
-
6. Create ADR + update README
|
|
199
|
+
6. Create ADR + update README
|