agileflow 2.51.0 → 2.55.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/README.md +82 -460
- package/package.json +18 -3
- package/scripts/agileflow-configure.js +134 -63
- package/scripts/agileflow-welcome.js +161 -31
- package/scripts/generators/agent-registry.js +2 -2
- package/scripts/generators/command-registry.js +6 -6
- package/scripts/generators/index.js +2 -6
- package/scripts/generators/inject-babysit.js +9 -2
- package/scripts/generators/inject-help.js +3 -1
- package/scripts/generators/inject-readme.js +7 -3
- package/scripts/generators/skill-registry.js +5 -5
- package/scripts/get-env.js +13 -12
- package/scripts/obtain-context.js +79 -26
- package/scripts/session-coordinator.sh +232 -0
- package/scripts/session-manager.js +512 -0
- package/src/core/agents/orchestrator.md +275 -0
- package/src/core/commands/adr.md +38 -16
- package/src/core/commands/agent.md +39 -22
- package/src/core/commands/assign.md +17 -0
- package/src/core/commands/auto.md +60 -46
- package/src/core/commands/babysit.md +302 -637
- package/src/core/commands/baseline.md +20 -0
- package/src/core/commands/blockers.md +33 -48
- package/src/core/commands/board.md +19 -0
- package/src/core/commands/changelog.md +20 -0
- package/src/core/commands/ci.md +17 -0
- package/src/core/commands/context.md +43 -40
- package/src/core/commands/debt.md +76 -45
- package/src/core/commands/deploy.md +20 -0
- package/src/core/commands/deps.md +40 -46
- package/src/core/commands/diagnose.md +24 -18
- package/src/core/commands/docs.md +18 -0
- package/src/core/commands/epic.md +31 -0
- package/src/core/commands/feedback.md +33 -21
- package/src/core/commands/handoff.md +29 -0
- package/src/core/commands/help.md +16 -7
- package/src/core/commands/impact.md +31 -61
- package/src/core/commands/metrics.md +17 -35
- package/src/core/commands/packages.md +21 -0
- package/src/core/commands/pr.md +15 -0
- package/src/core/commands/readme-sync.md +42 -9
- package/src/core/commands/research.md +58 -11
- package/src/core/commands/retro.md +42 -50
- package/src/core/commands/review.md +22 -27
- package/src/core/commands/session/end.md +53 -297
- package/src/core/commands/session/history.md +38 -257
- package/src/core/commands/session/init.md +44 -446
- package/src/core/commands/session/new.md +152 -0
- package/src/core/commands/session/resume.md +51 -447
- package/src/core/commands/session/status.md +32 -244
- package/src/core/commands/sprint.md +33 -0
- package/src/core/commands/status.md +18 -0
- package/src/core/commands/story-validate.md +32 -0
- package/src/core/commands/story.md +21 -6
- package/src/core/commands/template.md +18 -0
- package/src/core/commands/tests.md +22 -0
- package/src/core/commands/update.md +72 -58
- package/src/core/commands/validate-expertise.md +25 -37
- package/src/core/commands/velocity.md +33 -74
- package/src/core/commands/verify.md +16 -0
- package/src/core/experts/documentation/expertise.yaml +16 -2
- package/src/core/skills/agileflow-retro-facilitator/SKILL.md +57 -219
- package/src/core/skills/agileflow-retro-facilitator/cookbook/4ls.md +86 -0
- package/src/core/skills/agileflow-retro-facilitator/cookbook/glad-sad-mad.md +79 -0
- package/src/core/skills/agileflow-retro-facilitator/cookbook/start-stop-continue.md +142 -0
- package/src/core/skills/agileflow-retro-facilitator/prompts/action-items.md +83 -0
- package/src/core/skills/writing-skills/SKILL.md +352 -0
- package/src/core/skills/writing-skills/testing-skills-with-subagents.md +232 -0
- package/tools/cli/agileflow-cli.js +4 -2
- package/tools/cli/commands/config.js +20 -13
- package/tools/cli/commands/doctor.js +25 -9
- package/tools/cli/commands/list.js +10 -6
- package/tools/cli/commands/setup.js +54 -3
- package/tools/cli/commands/status.js +6 -8
- package/tools/cli/commands/uninstall.js +5 -5
- package/tools/cli/commands/update.js +51 -7
- package/tools/cli/installers/core/installer.js +8 -4
- package/tools/cli/installers/ide/_base-ide.js +3 -1
- package/tools/cli/installers/ide/claude-code.js +3 -7
- package/tools/cli/installers/ide/codex.js +440 -0
- package/tools/cli/installers/ide/manager.js +2 -6
- package/tools/cli/lib/content-injector.js +3 -3
- package/tools/cli/lib/docs-setup.js +3 -2
- package/tools/cli/lib/npm-utils.js +3 -3
- package/tools/cli/lib/ui.js +7 -7
- package/tools/cli/lib/version-checker.js +3 -3
- package/tools/postinstall.js +2 -3
package/README.md
CHANGED
|
@@ -3,531 +3,153 @@
|
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/agileflow)
|
|
6
|
-
[](
|
|
7
|
-
[](
|
|
8
|
-
[](
|
|
6
|
+
[](docs/04-architecture/commands.md)
|
|
7
|
+
[](docs/04-architecture/subagents.md)
|
|
8
|
+
[](docs/04-architecture/skills.md)
|
|
9
|
+
[](docs/04-architecture/agent-expert-system.md)
|
|
9
10
|
|
|
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
|
+
**AI-driven agile development for Claude Code, Cursor, Windsurf, OpenAI Codex CLI, and more.** Combining Scrum, Kanban, ADRs, and docs-as-code principles into one framework-agnostic system.
|
|
12
|
+
|
|
13
|
+
---
|
|
11
14
|
|
|
12
15
|
## Quick Start
|
|
13
16
|
|
|
14
17
|
### Installation
|
|
15
18
|
|
|
16
|
-
|
|
17
|
-
|
|
19
|
+
**Global (Recommended):**
|
|
18
20
|
```bash
|
|
19
21
|
npm install -g agileflow
|
|
20
22
|
agileflow setup
|
|
21
23
|
```
|
|
22
24
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
+
**Project-Level:**
|
|
25
26
|
```bash
|
|
26
27
|
npm install agileflow
|
|
27
28
|
npx agileflow setup
|
|
28
29
|
```
|
|
29
30
|
|
|
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 list # List installed components
|
|
45
|
-
agileflow doctor # Diagnose issues
|
|
46
|
-
agileflow uninstall # Remove from project
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
**Project-level installation (use `npx`):**
|
|
50
|
-
```bash
|
|
51
|
-
npx agileflow setup # Set up AgileFlow in project
|
|
52
|
-
npx agileflow status # Check installation + updates
|
|
53
|
-
npx agileflow update # Update to latest version
|
|
54
|
-
npx agileflow list # List installed components
|
|
55
|
-
npx agileflow doctor # Diagnose issues
|
|
56
|
-
npx agileflow uninstall # Remove from project
|
|
57
|
-
```
|
|
58
|
-
|
|
59
31
|
### After Setup
|
|
60
32
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
/agileflow:
|
|
64
|
-
|
|
65
|
-
Scaffolds docs structure, templates, and optional CI configuration.
|
|
66
|
-
|
|
67
|
-
**Get help:**
|
|
68
|
-
```
|
|
69
|
-
/agileflow:help
|
|
70
|
-
```
|
|
71
|
-
View system overview and available commands.
|
|
72
|
-
|
|
73
|
-
**Use the mentor (recommended):**
|
|
74
|
-
```
|
|
75
|
-
Use the mentor subagent to guide me through implementing <feature>
|
|
33
|
+
```bash
|
|
34
|
+
/agileflow:help # View all commands
|
|
35
|
+
/agileflow:babysit # Interactive mentor for implementation
|
|
36
|
+
/agileflow:configure # Configure hooks, status line, etc.
|
|
76
37
|
```
|
|
77
|
-
Interactive mentor guides you through epic/story creation, implementation, and PR preparation.
|
|
78
38
|
|
|
79
39
|
### Supported IDEs
|
|
80
40
|
|
|
81
41
|
| IDE | Status | Config Location |
|
|
82
42
|
|-----|--------|-----------------|
|
|
83
|
-
| Claude Code |
|
|
84
|
-
| Cursor |
|
|
85
|
-
| Windsurf |
|
|
43
|
+
| Claude Code | Supported | `.claude/commands/agileflow/` |
|
|
44
|
+
| Cursor | Supported | `.cursor/rules/agileflow/` |
|
|
45
|
+
| Windsurf | Supported | `.windsurf/workflows/agileflow/` |
|
|
46
|
+
| OpenAI Codex CLI | Supported | `.codex/skills/` |
|
|
47
|
+
|
|
48
|
+
---
|
|
86
49
|
|
|
87
50
|
## Why AgileFlow?
|
|
88
51
|
|
|
89
52
|
AgileFlow combines three proven methodologies:
|
|
90
53
|
|
|
91
|
-
- **Agile (Scrum/Kanban)** - Break work into Epics → Stories → Acceptance Criteria
|
|
54
|
+
- **Agile (Scrum/Kanban)** - Break work into Epics → Stories → Acceptance Criteria
|
|
92
55
|
- **ADRs** - Record architectural decisions so future teams don't re-debate
|
|
93
|
-
- **Docs-as-Code** - Humans and AI agents coordinate via versioned files
|
|
56
|
+
- **Docs-as-Code** - Humans and AI agents coordinate via versioned files
|
|
94
57
|
|
|
95
58
|
**Key Benefits:**
|
|
96
59
|
- Clear priorities and testable increments
|
|
97
60
|
- Durable memory and decision history
|
|
98
|
-
-
|
|
61
|
+
- Multi-agent collaboration via message bus
|
|
99
62
|
- Works with any tech stack or framework
|
|
100
63
|
|
|
101
|
-
|
|
102
|
-
<summary><strong>📁 Folder Structure</strong> (click to expand)</summary>
|
|
103
|
-
|
|
104
|
-
After running `/agileflow:setup`:
|
|
105
|
-
|
|
106
|
-
```
|
|
107
|
-
docs/
|
|
108
|
-
00-meta/ # Templates, glossary, conventions
|
|
109
|
-
01-brainstorming/ # Ideas and sketches
|
|
110
|
-
02-practices/ # Testing, git, CI, security practices
|
|
111
|
-
prompts/agents/ # Agent profiles and contracts
|
|
112
|
-
03-decisions/ # ADRs (Architecture Decision Records)
|
|
113
|
-
04-architecture/ # Architecture documentation
|
|
114
|
-
05-epics/ # Epic definitions
|
|
115
|
-
06-stories/ # User stories (grouped by epic)
|
|
116
|
-
07-testing/ # Test cases and acceptance criteria
|
|
117
|
-
08-project/ # Roadmap, backlog, milestones, risks
|
|
118
|
-
09-agents/ # Agent status and message bus
|
|
119
|
-
bus/log.jsonl # Agent communication log
|
|
120
|
-
status.json # Current story statuses
|
|
121
|
-
10-research/ # Saved research notes
|
|
122
|
-
context.md # One-page context brief for web AI tools
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
</details>
|
|
126
|
-
|
|
127
|
-
<details>
|
|
128
|
-
<summary><strong>📚 Commands</strong> (41 total - click to expand)</summary>
|
|
129
|
-
|
|
130
|
-
### Core Workflow
|
|
131
|
-
- `/agileflow:setup` - Bootstrap the entire system
|
|
132
|
-
- `/agileflow:help` - Display system overview
|
|
133
|
-
- `/agileflow:babysit` - Interactive mentor for end-to-end implementation
|
|
134
|
-
|
|
135
|
-
### Planning & Structure
|
|
136
|
-
- `/agileflow:epic` - Create a new epic
|
|
137
|
-
- `/agileflow:story` - Create a user story with acceptance criteria
|
|
138
|
-
- `/agileflow:story-validate` - Validate story completeness before development
|
|
139
|
-
- `/agileflow:sprint` - Data-driven sprint planning with velocity forecasting
|
|
140
|
-
- `/agileflow:adr` - Create an Architecture Decision Record
|
|
141
|
-
- `/agileflow:agent` - Onboard a new agent
|
|
142
|
-
|
|
143
|
-
### Task Management
|
|
144
|
-
- `/agileflow:assign` - Assign/reassign a story
|
|
145
|
-
- `/agileflow:status` - Update story status
|
|
146
|
-
- `/agileflow:handoff` - Document handoff between agents
|
|
147
|
-
|
|
148
|
-
### Quality & CI
|
|
149
|
-
- `/agileflow:pr` - Generate PR description
|
|
150
|
-
- `/agileflow:ci` - Bootstrap CI workflow
|
|
151
|
-
- `/agileflow:readme-sync` - Sync folder READMEs
|
|
152
|
-
- `/agileflow:tests` - Automated testing infrastructure setup
|
|
153
|
-
- `/agileflow:review` - AI-powered code review
|
|
154
|
-
- `/agileflow:verify` - Run tests and update story test status (Session Harness)
|
|
155
|
-
- `/agileflow:session-init` - Initialize session harness with test verification (Phase 2)
|
|
156
|
-
- `/agileflow:resume` - Resume session with environment verification and context (Phase 2)
|
|
157
|
-
- `/agileflow:baseline` - Mark current state as verified baseline (Phase 2)
|
|
158
|
-
- `/agileflow:compress` - Compress status.json (fixes token limit issues)
|
|
159
|
-
|
|
160
|
-
### Automation & DevOps
|
|
161
|
-
- `/agileflow:packages` - Manage dependencies (dashboard, updates, security audits)
|
|
162
|
-
- `/agileflow:docs` - Synchronize docs with code changes
|
|
163
|
-
- `/agileflow:impact` - Analyze change impact on codebase
|
|
164
|
-
- `/agileflow:debt` - Track and prioritize technical debt
|
|
165
|
-
- `/agileflow:deploy` - Automated deployment pipeline setup
|
|
166
|
-
- `/agileflow:changelog` - Auto-generate changelog from commits
|
|
167
|
-
- `/agileflow:auto` - Generate stories from PRDs/mockups/specs
|
|
168
|
-
- `/agileflow:template` - Create and manage custom templates
|
|
169
|
-
- `/agileflow:feedback` - Collect feedback for continuous improvement
|
|
170
|
-
- `/agileflow:update` - Generate stakeholder reports
|
|
171
|
-
|
|
172
|
-
### Visualization & Analytics
|
|
173
|
-
- `/agileflow:board` - Visual kanban board with WIP limits
|
|
174
|
-
- `/agileflow:blockers` - Comprehensive blocker tracking with resolution suggestions
|
|
175
|
-
- `/agileflow:velocity` - Velocity tracking and forecasting
|
|
176
|
-
- `/agileflow:metrics` - Analytics dashboard (cycle time, lead time, throughput, flow efficiency)
|
|
177
|
-
- `/agileflow:retro` - Automated retrospective generator with insights
|
|
178
|
-
- `/agileflow:deps` - Dependency graph visualization with critical path detection
|
|
179
|
-
|
|
180
|
-
### Web AI Integration
|
|
181
|
-
- `/agileflow:context` - Generate/export/manage context for web AI tools (ChatGPT, Perplexity, Gemini, Claude, etc.)
|
|
182
|
-
- `/agileflow:research` - Save research notes
|
|
183
|
-
|
|
184
|
-
</details>
|
|
185
|
-
|
|
186
|
-
<details>
|
|
187
|
-
<summary><strong>🤖 Subagents</strong> (26 specialized agents - click to expand)</summary>
|
|
188
|
-
|
|
189
|
-
AgileFlow includes **26 specialized subagents** that operate in separate context windows for focused work. See [SUBAGENTS.md](SUBAGENTS.md) for complete documentation.
|
|
190
|
-
|
|
191
|
-
### Core Implementation Agents
|
|
192
|
-
|
|
193
|
-
**`ui`** - UI/Presentation Layer Specialist
|
|
194
|
-
- Front-end components, styling, theming, accessibility (WCAG 2.1 AA)
|
|
195
|
-
- Invocation: "Use the ui subagent to implement this UI feature"
|
|
196
|
-
|
|
197
|
-
**`api`** - Services/Data Layer Specialist
|
|
198
|
-
- Backend APIs, business logic, data models, API tests
|
|
199
|
-
- Invocation: "Use the api subagent to implement this API endpoint"
|
|
200
|
-
|
|
201
|
-
**`ci`** - CI/CD & Quality Specialist
|
|
202
|
-
- CI/CD pipelines, linting, type checking, test coverage
|
|
203
|
-
- Invocation: "Use the ci subagent to set up the test pipeline"
|
|
204
|
-
|
|
205
|
-
### Orchestration & Planning Agents
|
|
206
|
-
|
|
207
|
-
**`mentor`** - End-to-End Implementation Mentor
|
|
208
|
-
- Guides feature implementation from idea to PR
|
|
209
|
-
- Invocation: "Use the mentor subagent to guide me through this feature"
|
|
210
|
-
|
|
211
|
-
**`epic-planner`** - Epic & Story Planning Specialist
|
|
212
|
-
- Breaks down features into epics and stories with acceptance criteria
|
|
213
|
-
- Invocation: "Use the epic-planner subagent to plan this feature"
|
|
214
|
-
|
|
215
|
-
**`adr-writer`** - Architecture Decision Record Specialist
|
|
216
|
-
- Documents technical decisions, trade-offs, alternatives
|
|
217
|
-
- Invocation: "Use the adr-writer subagent to document this decision"
|
|
218
|
-
|
|
219
|
-
**`research`** - Research & Knowledge Management Specialist
|
|
220
|
-
- Conducts technical research, builds research prompts, saves notes
|
|
221
|
-
- Invocation: "Use the research subagent to research authentication approaches"
|
|
222
|
-
|
|
223
|
-
### Additional Specialized Agents
|
|
224
|
-
- `devops` - DevOps & Automation
|
|
225
|
-
- `security` - Security & Compliance
|
|
226
|
-
- `database` - Database & Data Layer
|
|
227
|
-
- `testing` - Testing & QA Automation
|
|
228
|
-
- `product` - Product Management & Prioritization
|
|
229
|
-
- `performance` - Performance Optimization
|
|
230
|
-
- `mobile` - Mobile Development
|
|
231
|
-
- `integrations` - Third-Party Integrations
|
|
232
|
-
- `refactor` - Code Refactoring & Technical Debt
|
|
233
|
-
- `design` - Design Systems & UI/UX
|
|
234
|
-
- `accessibility` - Accessibility Compliance (WCAG)
|
|
235
|
-
- `analytics` - Analytics & Metrics Implementation
|
|
236
|
-
- `datamigration` - Data Migration & ETL
|
|
237
|
-
- `qa` - Quality Assurance & Test Planning
|
|
238
|
-
- And more...
|
|
239
|
-
|
|
240
|
-
**When to Use Subagents:**
|
|
241
|
-
- Complex, multi-step implementation work
|
|
242
|
-
- Specialized tasks requiring focused expertise
|
|
243
|
-
- Work benefiting from separate context
|
|
244
|
-
- Tasks needing to run commands or write code
|
|
245
|
-
|
|
246
|
-
**When to Use Commands:**
|
|
247
|
-
- Quick, single-purpose actions
|
|
248
|
-
- Status updates and assignments
|
|
249
|
-
- Generating templates or prompts
|
|
250
|
-
- Simple file operations
|
|
251
|
-
|
|
252
|
-
</details>
|
|
253
|
-
|
|
254
|
-
<details>
|
|
255
|
-
<summary><strong>🎯 Skills</strong> (23 auto-loaded skills - click to expand)</summary>
|
|
256
|
-
|
|
257
|
-
Skills are **context-aware helpers** that activate automatically based on keywords (no manual invocation needed).
|
|
258
|
-
|
|
259
|
-
### How Skills Work
|
|
260
|
-
- **Activation:** Automatic (keyword-based detection)
|
|
261
|
-
- **Context:** Main conversation
|
|
262
|
-
- **Purpose:** Quick enhancements and formatting
|
|
263
|
-
- **Structure:** Follow Anthropic's minimal specification (v2.21.0+)
|
|
264
|
-
|
|
265
|
-
### Skills by Category
|
|
266
|
-
|
|
267
|
-
#### AgileFlow Skills (8 skills)
|
|
268
|
-
Auto-formatted outputs following AgileFlow templates:
|
|
269
|
-
- `agileflow-story-writer` - Converts discussions to user stories
|
|
270
|
-
- `agileflow-acceptance-criteria` - Generates Given/When/Then AC
|
|
271
|
-
- `epic-planner` - Breaks features into epics/stories
|
|
272
|
-
- `agileflow-sprint-planner` - Plans sprints with velocity
|
|
273
|
-
- `agileflow-retro-facilitator` - Structures retrospectives
|
|
274
|
-
- `agileflow-adr` - Captures architectural decisions
|
|
275
|
-
- `agileflow-commit-messages` - Formats Conventional Commits
|
|
276
|
-
- `agileflow-tech-debt` - Tracks technical debt
|
|
277
|
-
|
|
278
|
-
#### Template Generators (15 skills)
|
|
279
|
-
Generate code templates and documentation:
|
|
280
|
-
- `story-skeleton` - Story template scaffolding
|
|
281
|
-
- `acceptance-criteria-generator` - AC formatting
|
|
282
|
-
- `commit-message-formatter` - Git commit messages
|
|
283
|
-
- `adr-template` - Architecture decision records
|
|
284
|
-
- `api-documentation-generator` - OpenAPI/Swagger docs
|
|
285
|
-
- `changelog-entry` - Keep a Changelog format
|
|
286
|
-
- `pr-description` - Pull request descriptions
|
|
287
|
-
- `test-case-generator` - Test cases from AC
|
|
288
|
-
- `type-definitions` - TypeScript interfaces
|
|
289
|
-
- `sql-schema-generator` - SQL schemas with migrations
|
|
290
|
-
- `error-handler-template` - Error handling patterns
|
|
291
|
-
- `diagram-generator` - Mermaid/ASCII diagrams
|
|
292
|
-
- `validation-schema-generator` - Joi/Zod/Yup schemas
|
|
293
|
-
- `deployment-guide-generator` - Deployment runbooks
|
|
294
|
-
- `migration-checklist` - Data migration checklists
|
|
295
|
-
|
|
296
|
-
### Example Activation
|
|
297
|
-
```
|
|
298
|
-
User: "I need to create a user story for login functionality"
|
|
299
|
-
[agileflow-story-writer skill activates automatically]
|
|
300
|
-
Claude: Generates formatted story with AC, owner, priority, estimate
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
</details>
|
|
304
|
-
|
|
305
|
-
<details>
|
|
306
|
-
<summary><strong>🎯 Hooks System</strong> (event-driven automation - click to expand)</summary>
|
|
307
|
-
|
|
308
|
-
AgileFlow supports **event-driven automation** through Claude Code's official hooks system.
|
|
309
|
-
|
|
310
|
-
### What Are Hooks?
|
|
311
|
-
|
|
312
|
-
Hooks are automatic triggers that execute commands in response to events:
|
|
313
|
-
- **SessionStart** - Runs when Claude Code session starts
|
|
314
|
-
- **UserPromptSubmit** - Runs after you submit a prompt
|
|
315
|
-
- **Stop** - Runs when Claude stops responding
|
|
316
|
-
|
|
317
|
-
### Quick Setup
|
|
318
|
-
|
|
319
|
-
1. **Create .claude directory:**
|
|
320
|
-
```bash
|
|
321
|
-
mkdir -p .claude
|
|
322
|
-
```
|
|
323
|
-
|
|
324
|
-
2. **Copy template:**
|
|
325
|
-
```bash
|
|
326
|
-
cp templates/claude-settings.example.json .claude/settings.json
|
|
327
|
-
```
|
|
328
|
-
|
|
329
|
-
3. **Customize hooks** (edit `.claude/settings.json`):
|
|
330
|
-
```json
|
|
331
|
-
{
|
|
332
|
-
"hooks": {
|
|
333
|
-
"SessionStart": [{
|
|
334
|
-
"hooks": [{
|
|
335
|
-
"type": "command",
|
|
336
|
-
"command": "echo '🚀 AgileFlow loaded - Type /agileflow:help'"
|
|
337
|
-
}]
|
|
338
|
-
}]
|
|
339
|
-
}
|
|
340
|
-
}
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
4. **Restart Claude Code**
|
|
344
|
-
|
|
345
|
-
### Example Use Cases
|
|
346
|
-
|
|
347
|
-
**Welcome message:**
|
|
348
|
-
```json
|
|
349
|
-
{
|
|
350
|
-
"SessionStart": [{
|
|
351
|
-
"hooks": [{
|
|
352
|
-
"type": "command",
|
|
353
|
-
"command": "echo '👋 Welcome! Current sprint: $(cat docs/08-project/current-sprint.txt)'"
|
|
354
|
-
}]
|
|
355
|
-
}]
|
|
356
|
-
}
|
|
357
|
-
```
|
|
358
|
-
|
|
359
|
-
**Activity logging:**
|
|
360
|
-
```json
|
|
361
|
-
{
|
|
362
|
-
"UserPromptSubmit": [{
|
|
363
|
-
"hooks": [{
|
|
364
|
-
"type": "command",
|
|
365
|
-
"command": "echo '[LOG] Prompt at $(date)' >> .claude/activity.log"
|
|
366
|
-
}]
|
|
367
|
-
}]
|
|
368
|
-
}
|
|
369
|
-
```
|
|
64
|
+
---
|
|
370
65
|
|
|
371
|
-
|
|
372
|
-
- `.claude/settings.json` - Project-level config (committed to git)
|
|
373
|
-
- `.claude/settings.local.json` - User-specific overrides (gitignored)
|
|
66
|
+
## Core Components
|
|
374
67
|
|
|
375
|
-
|
|
68
|
+
| Component | Count | Description |
|
|
69
|
+
|-----------|-------|-------------|
|
|
70
|
+
| [Commands](docs/04-architecture/commands.md) | 41 | Slash commands for agile workflows |
|
|
71
|
+
| [Subagents](docs/04-architecture/subagents.md) | 26 | Specialized agents for focused work |
|
|
72
|
+
| [Skills](docs/04-architecture/skills.md) | 23 | Auto-activated context helpers |
|
|
73
|
+
| [Experts](docs/04-architecture/agent-expert-system.md) | 26 | Self-improving knowledge bases |
|
|
376
74
|
|
|
377
|
-
|
|
378
|
-
<summary><strong>🔧 Advanced Topics</strong> (click to expand)</summary>
|
|
75
|
+
---
|
|
379
76
|
|
|
380
|
-
|
|
77
|
+
## Documentation
|
|
381
78
|
|
|
382
|
-
|
|
383
|
-
2. **Implement to AC** - Follow acceptance criteria
|
|
384
|
-
3. **Write tests** - Reference `docs/07-testing/test-cases/<STORY_ID>.md`
|
|
385
|
-
4. **Update status** - Use `/agileflow:status`
|
|
386
|
-
5. **Create PR** - Use `/agileflow:pr`
|
|
387
|
-
6. **Mark done** - Update status after merge
|
|
79
|
+
Full documentation lives in [`docs/04-architecture/`](docs/04-architecture/):
|
|
388
80
|
|
|
389
|
-
###
|
|
81
|
+
### Reference
|
|
82
|
+
- [Commands](docs/04-architecture/commands.md) - All 41 slash commands
|
|
83
|
+
- [Subagents](docs/04-architecture/subagents.md) - All 26 specialized agents
|
|
84
|
+
- [Skills](docs/04-architecture/skills.md) - 23 auto-loaded skills
|
|
390
85
|
|
|
391
|
-
|
|
392
|
-
-
|
|
393
|
-
-
|
|
394
|
-
-
|
|
395
|
-
-
|
|
86
|
+
### Architecture
|
|
87
|
+
- [AgileFlow CLI Overview](docs/04-architecture/agileflow-cli-overview.md) - System architecture
|
|
88
|
+
- [Agent Expert System](docs/04-architecture/agent-expert-system.md) - Self-improving agents
|
|
89
|
+
- [Multi-Expert Orchestration](docs/04-architecture/multi-expert-orchestration.md) - Parallel expert analysis
|
|
90
|
+
- [Multi-Session Coordination](docs/04-architecture/multi-session-coordination.md) - Parallel Claude Code sessions
|
|
396
91
|
|
|
397
|
-
###
|
|
92
|
+
### Configuration
|
|
93
|
+
- [Configuration System](docs/04-architecture/configuration-system.md) - 8 configuration agents
|
|
94
|
+
- [Hooks System](docs/04-architecture/hooks-system.md) - Event-driven automation
|
|
95
|
+
- [Session Harness](docs/04-architecture/session-harness.md) - Test verification and sessions
|
|
96
|
+
- [PreCompact Context](docs/04-architecture/precompact-context.md) - Context preservation during compacts
|
|
398
97
|
|
|
399
|
-
|
|
98
|
+
---
|
|
400
99
|
|
|
401
|
-
|
|
402
|
-
- Preserve AI context when switching tasks
|
|
403
|
-
- Handle production bugs without losing feature flow
|
|
404
|
-
- Compare implementations side-by-side
|
|
405
|
-
- Test risky refactors in isolation
|
|
100
|
+
## Examples
|
|
406
101
|
|
|
407
|
-
|
|
102
|
+
### Create an Epic with Stories
|
|
408
103
|
```bash
|
|
409
|
-
|
|
410
|
-
./docs/00-meta/scripts/worktree-create.sh auth-hotfix
|
|
411
|
-
|
|
412
|
-
# Open in new window
|
|
413
|
-
code ../myapp-auth-hotfix
|
|
414
|
-
/agileflow:babysit
|
|
104
|
+
/agileflow:epic EPIC=EP-0001 TITLE="User Authentication" OWNER=AG-API GOAL="Secure login"
|
|
415
105
|
```
|
|
416
106
|
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
### Web AI Integration
|
|
420
|
-
|
|
421
|
-
Share context with web AI tools (ChatGPT, Perplexity, Gemini, Claude, etc.):
|
|
422
|
-
|
|
423
|
-
1. Run `/agileflow:context` to generate/refresh context
|
|
424
|
-
2. Use `/agileflow:context MODE=export` for concise excerpt
|
|
425
|
-
3. Paste into web AI tool for research/ideation
|
|
426
|
-
4. Use `/agileflow:context MODE=research TOPIC="..."` for structured prompts
|
|
427
|
-
5. Save results with `/agileflow:research`
|
|
428
|
-
|
|
429
|
-
### Session Harness System (v2.24.0+)
|
|
430
|
-
|
|
431
|
-
Ensures test verification and session continuity for long-running projects. Prevents agents from breaking functionality and maintains progress across context windows.
|
|
432
|
-
|
|
433
|
-
**The Problem:**
|
|
434
|
-
Without verification, agents can:
|
|
435
|
-
- Break existing functionality without noticing
|
|
436
|
-
- Claim features work when tests fail
|
|
437
|
-
- Lose context between sessions
|
|
438
|
-
- Mark incomplete work as finished
|
|
439
|
-
|
|
440
|
-
**The Solution:**
|
|
441
|
-
Session Harness System tracks test status, verifies baselines, and maintains session state.
|
|
442
|
-
|
|
443
|
-
**Quick Start:**
|
|
107
|
+
### Work on a Story
|
|
444
108
|
```bash
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
# Start each session (or auto-run via hook)
|
|
449
|
-
/agileflow:resume
|
|
450
|
-
|
|
451
|
-
# Run tests and update test status
|
|
452
|
-
/agileflow:verify
|
|
453
|
-
|
|
454
|
-
# Create verified checkpoint
|
|
455
|
-
/agileflow:baseline "Sprint 12 complete"
|
|
109
|
+
/agileflow:assign STORY=US-0001 NEW_OWNER=AG-UI NEW_STATUS=in-progress
|
|
110
|
+
# ... implement ...
|
|
111
|
+
/agileflow:status STORY=US-0001 STATUS=in-review SUMMARY="Login form complete"
|
|
456
112
|
```
|
|
457
113
|
|
|
458
|
-
|
|
459
|
-
1. **Test Tracking**: Every story has `test_status` field (passing/failing/not_run)
|
|
460
|
-
2. **Pre-Implementation**: Agents check test_status before starting work
|
|
461
|
-
3. **Post-Implementation**: Agents run `/agileflow:verify` before marking complete
|
|
462
|
-
4. **Session Resume**: Loads context and detects regressions
|
|
463
|
-
5. **Baselines**: Git tags mark known-good states for reset points
|
|
464
|
-
|
|
465
|
-
**Benefits:**
|
|
466
|
-
- **No Broken Baselines**: Agents can't mark stories complete with failing tests
|
|
467
|
-
- **Fail Fast**: Catch regressions immediately, not at PR review
|
|
468
|
-
- **Context Continuity**: Structured handoff between sessions
|
|
469
|
-
- **Regression Detection**: Alerts when tests were passing, now failing
|
|
470
|
-
|
|
471
|
-
**Agent Integration (v2.26.0):**
|
|
472
|
-
All 18 dev agents now include verification protocol:
|
|
473
|
-
- ui, api, ci, devops
|
|
474
|
-
- security, database, testing
|
|
475
|
-
- performance, mobile, integrations
|
|
476
|
-
- refactor, design, accessibility
|
|
477
|
-
- analytics, datamigration, monitoring
|
|
478
|
-
- compliance, qa
|
|
479
|
-
|
|
480
|
-
**Learn More:** See CLAUDE.md "Session Harness System" section for complete documentation.
|
|
481
|
-
|
|
482
|
-
### Status.json Compression
|
|
483
|
-
|
|
484
|
-
Prevent "file too large" errors:
|
|
485
|
-
|
|
114
|
+
### Use Multi-Expert Analysis
|
|
486
115
|
```bash
|
|
487
|
-
|
|
488
|
-
/agileflow:compress
|
|
489
|
-
|
|
490
|
-
# Typical result: 80-90% size reduction
|
|
116
|
+
/agileflow:multi-expert Is this authentication implementation secure?
|
|
491
117
|
```
|
|
492
118
|
|
|
493
|
-
|
|
119
|
+
### Work in Parallel Sessions
|
|
120
|
+
```bash
|
|
121
|
+
/agileflow:session:new # Create isolated workspace
|
|
122
|
+
/agileflow:session:status # View all sessions
|
|
123
|
+
```
|
|
494
124
|
|
|
495
|
-
|
|
125
|
+
---
|
|
496
126
|
|
|
497
|
-
##
|
|
127
|
+
## Project Structure
|
|
498
128
|
|
|
499
|
-
|
|
500
|
-
```
|
|
501
|
-
/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"
|
|
502
|
-
```
|
|
129
|
+
After running `agileflow setup`:
|
|
503
130
|
|
|
504
|
-
### Working on a Story
|
|
505
131
|
```
|
|
506
|
-
/
|
|
507
|
-
#
|
|
508
|
-
/
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
/
|
|
132
|
+
docs/
|
|
133
|
+
00-meta/ # Templates, conventions
|
|
134
|
+
01-brainstorming/ # Ideas and sketches
|
|
135
|
+
02-practices/ # Testing, git, CI practices
|
|
136
|
+
03-decisions/ # ADRs
|
|
137
|
+
04-architecture/ # Architecture documentation
|
|
138
|
+
05-epics/ # Epic definitions
|
|
139
|
+
06-stories/ # User stories
|
|
140
|
+
07-testing/ # Test cases
|
|
141
|
+
08-project/ # Roadmap, backlog
|
|
142
|
+
09-agents/ # Agent status, message bus
|
|
143
|
+
10-research/ # Research notes
|
|
514
144
|
```
|
|
515
145
|
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
All templates are located in `templates/` and `docs/00-meta/templates/`:
|
|
146
|
+
---
|
|
519
147
|
|
|
520
|
-
|
|
521
|
-
- `story-template.md` - User story format
|
|
522
|
-
- `adr-template.md` - Architecture decision record
|
|
523
|
-
- `agent-profile-template.md` - Agent profile and contract
|
|
524
|
-
- `comms-note-template.md` - Handoff documentation
|
|
525
|
-
- `research-template.md` - Research note structure
|
|
526
|
-
- `README-template.md` - Folder README template
|
|
148
|
+
## Online Documentation
|
|
527
149
|
|
|
528
|
-
|
|
150
|
+
Visit [projectquestorg.com](https://projectquestorg.com) for the full documentation site.
|
|
529
151
|
|
|
530
|
-
|
|
152
|
+
---
|
|
531
153
|
|
|
532
154
|
## License
|
|
533
155
|
|
|
@@ -535,4 +157,4 @@ MIT
|
|
|
535
157
|
|
|
536
158
|
## Support
|
|
537
159
|
|
|
538
|
-
For issues or questions,
|
|
160
|
+
For issues or questions, visit the [GitHub repository](https://github.com/projectquestorg/AgileFlow).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agileflow",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.55.0",
|
|
4
4
|
"description": "AI-driven agile development system for Claude Code, Cursor, Windsurf, and more",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"agile",
|
|
@@ -41,8 +41,14 @@
|
|
|
41
41
|
"agileflow:setup": "node tools/cli/agileflow-cli.js setup",
|
|
42
42
|
"agileflow:status": "node tools/cli/agileflow-cli.js status",
|
|
43
43
|
"agileflow:update": "node tools/cli/agileflow-cli.js update",
|
|
44
|
-
"lint": "
|
|
45
|
-
"
|
|
44
|
+
"lint": "eslint .",
|
|
45
|
+
"lint:strict": "eslint . --max-warnings 0",
|
|
46
|
+
"lint:fix": "eslint . --fix",
|
|
47
|
+
"format": "prettier --write .",
|
|
48
|
+
"format:check": "prettier --check .",
|
|
49
|
+
"test": "jest",
|
|
50
|
+
"test:watch": "jest --watch",
|
|
51
|
+
"test:coverage": "jest --coverage"
|
|
46
52
|
},
|
|
47
53
|
"dependencies": {
|
|
48
54
|
"chalk": "^4.1.2",
|
|
@@ -58,5 +64,14 @@
|
|
|
58
64
|
},
|
|
59
65
|
"publishConfig": {
|
|
60
66
|
"access": "public"
|
|
67
|
+
},
|
|
68
|
+
"devDependencies": {
|
|
69
|
+
"@eslint/js": "^9.39.2",
|
|
70
|
+
"eslint": "^9.39.2",
|
|
71
|
+
"eslint-config-prettier": "^10.1.8",
|
|
72
|
+
"eslint-plugin-prettier": "^5.5.4",
|
|
73
|
+
"globals": "^16.5.0",
|
|
74
|
+
"jest": "^30.2.0",
|
|
75
|
+
"prettier": "^3.7.4"
|
|
61
76
|
}
|
|
62
77
|
}
|