agileflow
v2.35.0
Published
AI-driven agile development system for Claude Code, Cursor, Windsurf, and more
Maintainers
Readme
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.
Quick Start
Installation
Option 1: Global Installation (Recommended)
npm install -g agileflow
agileflow setupOption 2: Project-Level Installation
npm install agileflow
npx agileflow setupThis will:
- Prompt where to install AgileFlow
- Prompt to select your IDE(s)
- Install AgileFlow core (commands, agents, skills)
- Configure your selected IDEs
- Create documentation structure
CLI Commands
Global installation:
agileflow setup # Set up AgileFlow in project
agileflow status # Check installation + updates
agileflow update # Update to latest version
agileflow doctor # Diagnose issues
agileflow uninstall # Remove from projectProject-level installation (use npx):
npx agileflow setup # Set up AgileFlow in project
npx agileflow status # Check installation + updates
npx agileflow update # Update to latest version
npx agileflow doctor # Diagnose issues
npx agileflow uninstall # Remove from projectAfter Setup
Initialize the system:
/AgileFlow:setupScaffolds docs structure, templates, and optional CI configuration.
Get help:
/AgileFlow:helpView system overview and available commands.
Use the mentor (recommended):
Use the mentor subagent to guide me through implementing <feature>Interactive mentor guides you through epic/story creation, implementation, and PR preparation.
Supported IDEs
| IDE | Status | Config Location |
|-----|--------|-----------------|
| Claude Code | ✅ Supported | .claude/commands/AgileFlow/ |
| Cursor | ✅ Supported | .cursor/rules/agileflow/ |
| Windsurf | ✅ Supported | .windsurf/workflows/agileflow/ |
Why AgileFlow?
AgileFlow combines three proven methodologies:
- Agile (Scrum/Kanban) - Break work into Epics → Stories → Acceptance Criteria with WIP limits
- ADRs - Record architectural decisions so future teams don't re-debate
- Docs-as-Code - Humans and AI agents coordinate via versioned files (traceable, reviewable, automatable)
Key Benefits:
- Clear priorities and testable increments
- Durable memory and decision history
- Effortless multi-agent collaboration via message bus
- Works with any tech stack or framework
After running /AgileFlow:setup:
docs/
00-meta/ # Templates, glossary, conventions
01-brainstorming/ # Ideas and sketches
02-practices/ # Testing, git, CI, security practices
prompts/agents/ # Agent profiles and contracts
03-decisions/ # ADRs (Architecture Decision Records)
04-architecture/ # Architecture documentation
05-epics/ # Epic definitions
06-stories/ # User stories (grouped by epic)
07-testing/ # Test cases and acceptance criteria
08-project/ # Roadmap, backlog, milestones, risks
09-agents/ # Agent status and message bus
bus/log.jsonl # Agent communication log
status.json # Current story statuses
10-research/ # Saved research notes
context.md # One-page context brief for web AI toolsCore Workflow
/AgileFlow:setup- Bootstrap the entire system/AgileFlow:help- Display system overview/AgileFlow:babysit- Interactive mentor for end-to-end implementation
Planning & Structure
/AgileFlow:epic- Create a new epic/AgileFlow:story- Create a user story with acceptance criteria/AgileFlow:story-validate- Validate story completeness before development/AgileFlow:sprint- Data-driven sprint planning with velocity forecasting/AgileFlow:adr- Create an Architecture Decision Record/AgileFlow:agent- Onboard a new agent
Task Management
/AgileFlow:assign- Assign/reassign a story/AgileFlow:status- Update story status/AgileFlow:handoff- Document handoff between agents
Quality & CI
/AgileFlow:pr- Generate PR description/AgileFlow:ci- Bootstrap CI workflow/AgileFlow:readme-sync- Sync folder READMEs/AgileFlow:tests- Automated testing infrastructure setup/AgileFlow:review- AI-powered code review/AgileFlow:verify- Run tests and update story test status (Session Harness)/AgileFlow:session-init- Initialize session harness with test verification (Phase 2)/AgileFlow:resume- Resume session with environment verification and context (Phase 2)/AgileFlow:baseline- Mark current state as verified baseline (Phase 2)/AgileFlow:compress- Compress status.json (fixes token limit issues)
Automation & DevOps
/AgileFlow:packages- Manage dependencies (dashboard, updates, security audits)/AgileFlow:docs- Synchronize docs with code changes/AgileFlow:impact- Analyze change impact on codebase/AgileFlow:debt- Track and prioritize technical debt/AgileFlow:deploy- Automated deployment pipeline setup/AgileFlow:changelog- Auto-generate changelog from commits/AgileFlow:auto- Generate stories from PRDs/mockups/specs/AgileFlow:template- Create and manage custom templates/AgileFlow:feedback- Collect feedback for continuous improvement/AgileFlow:update- Generate stakeholder reports
Visualization & Analytics
/AgileFlow:board- Visual kanban board with WIP limits/AgileFlow:blockers- Comprehensive blocker tracking with resolution suggestions/AgileFlow:velocity- Velocity tracking and forecasting/AgileFlow:metrics- Analytics dashboard (cycle time, lead time, throughput, flow efficiency)/AgileFlow:retro- Automated retrospective generator with insights/AgileFlow:deps- Dependency graph visualization with critical path detection
Web AI Integration
/AgileFlow:context- Generate/export/manage context for web AI tools (ChatGPT, Perplexity, Gemini, Claude, etc.)/AgileFlow:research- Save research notes
AgileFlow includes 26 specialized subagents that operate in separate context windows for focused work. See SUBAGENTS.md for complete documentation.
Core Implementation Agents
ui - UI/Presentation Layer Specialist
- Front-end components, styling, theming, accessibility (WCAG 2.1 AA)
- Invocation: "Use the ui subagent to implement this UI feature"
api - Services/Data Layer Specialist
- Backend APIs, business logic, data models, API tests
- Invocation: "Use the api subagent to implement this API endpoint"
ci - CI/CD & Quality Specialist
- CI/CD pipelines, linting, type checking, test coverage
- Invocation: "Use the ci subagent to set up the test pipeline"
Orchestration & Planning Agents
mentor - End-to-End Implementation Mentor
- Guides feature implementation from idea to PR
- Invocation: "Use the mentor subagent to guide me through this feature"
epic-planner - Epic & Story Planning Specialist
- Breaks down features into epics and stories with acceptance criteria
- Invocation: "Use the epic-planner subagent to plan this feature"
adr-writer - Architecture Decision Record Specialist
- Documents technical decisions, trade-offs, alternatives
- Invocation: "Use the adr-writer subagent to document this decision"
research - Research & Knowledge Management Specialist
- Conducts technical research, builds research prompts, saves notes
- Invocation: "Use the research subagent to research authentication approaches"
Additional Specialized Agents
devops- DevOps & Automationsecurity- Security & Compliancedatabase- Database & Data Layertesting- Testing & QA Automationproduct- Product Management & Prioritizationperformance- Performance Optimizationmobile- Mobile Developmentintegrations- Third-Party Integrationsrefactor- Code Refactoring & Technical Debtdesign- Design Systems & UI/UXaccessibility- Accessibility Compliance (WCAG)analytics- Analytics & Metrics Implementationdatamigration- Data Migration & ETLqa- Quality Assurance & Test Planning- And more...
When to Use Subagents:
- Complex, multi-step implementation work
- Specialized tasks requiring focused expertise
- Work benefiting from separate context
- Tasks needing to run commands or write code
When to Use Commands:
- Quick, single-purpose actions
- Status updates and assignments
- Generating templates or prompts
- Simple file operations
Skills are context-aware helpers that activate automatically based on keywords (no manual invocation needed).
How Skills Work
- Activation: Automatic (keyword-based detection)
- Context: Main conversation
- Purpose: Quick enhancements and formatting
- Structure: Follow Anthropic's minimal specification (v2.21.0+)
Skills by Category
AgileFlow Skills (8 skills)
Auto-formatted outputs following AgileFlow templates:
agileflow-story-writer- Converts discussions to user storiesagileflow-acceptance-criteria- Generates Given/When/Then ACepic-planner- Breaks features into epics/storiesagileflow-sprint-planner- Plans sprints with velocityagileflow-retro-facilitator- Structures retrospectivesagileflow-adr- Captures architectural decisionsagileflow-commit-messages- Formats Conventional Commitsagileflow-tech-debt- Tracks technical debt
Template Generators (15 skills)
Generate code templates and documentation:
story-skeleton- Story template scaffoldingacceptance-criteria-generator- AC formattingcommit-message-formatter- Git commit messagesadr-template- Architecture decision recordsapi-documentation-generator- OpenAPI/Swagger docschangelog-entry- Keep a Changelog formatpr-description- Pull request descriptionstest-case-generator- Test cases from ACtype-definitions- TypeScript interfacessql-schema-generator- SQL schemas with migrationserror-handler-template- Error handling patternsdiagram-generator- Mermaid/ASCII diagramsvalidation-schema-generator- Joi/Zod/Yup schemasdeployment-guide-generator- Deployment runbooksmigration-checklist- Data migration checklists
Example Activation
User: "I need to create a user story for login functionality"
[agileflow-story-writer skill activates automatically]
Claude: Generates formatted story with AC, owner, priority, estimateAgileFlow supports event-driven automation through Claude Code's official hooks system.
What Are Hooks?
Hooks are automatic triggers that execute commands in response to events:
- SessionStart - Runs when Claude Code session starts
- UserPromptSubmit - Runs after you submit a prompt
- Stop - Runs when Claude stops responding
Quick Setup
Create .claude directory:
mkdir -p .claudeCopy template:
cp templates/claude-settings.example.json .claude/settings.jsonCustomize hooks (edit
.claude/settings.json):{ "hooks": { "SessionStart": [{ "hooks": [{ "type": "command", "command": "echo '🚀 AgileFlow loaded - Type /AgileFlow:help'" }] }] } }Restart Claude Code
Example Use Cases
Welcome message:
{
"SessionStart": [{
"hooks": [{
"type": "command",
"command": "echo '👋 Welcome! Current sprint: $(cat docs/08-project/current-sprint.txt)'"
}]
}]
}Activity logging:
{
"UserPromptSubmit": [{
"hooks": [{
"type": "command",
"command": "echo '[LOG] Prompt at $(date)' >> .claude/activity.log"
}]
}]
}Configuration Files
.claude/settings.json- Project-level config (committed to git).claude/settings.local.json- User-specific overrides (gitignored)
Daily Workflow
- Pick a story - Use
mentoror checkdocs/09-agents/status.json - Implement to AC - Follow acceptance criteria
- Write tests - Reference
docs/07-testing/test-cases/<STORY_ID>.md - Update status - Use
/AgileFlow:status - Create PR - Use
/AgileFlow:pr - Mark done - Update status after merge
Multi-Agent Collaboration
AgileFlow uses a message bus (docs/09-agents/bus/log.jsonl) for coordination:
- Agents update
docs/09-agents/status.jsonwith current work - Messages logged to bus for async communication
- Use
/AgileFlow:handoffto transfer work between agents - WIP limit: max 2 stories per agent
Git Worktrees for Context Preservation
For advanced users handling urgent hotfixes during feature work:
Benefits:
- Preserve AI context when switching tasks
- Handle production bugs without losing feature flow
- Compare implementations side-by-side
- Test risky refactors in isolation
Quick Start:
# Use helper script (created by /AgileFlow:setup)
./docs/00-meta/scripts/worktree-create.sh auth-hotfix
# Open in new window
code ../myapp-auth-hotfix
/AgileFlow:babysitSee docs/00-meta/guides/worktrees.md for comprehensive guide.
Web AI Integration
Share context with web AI tools (ChatGPT, Perplexity, Gemini, Claude, etc.):
- Run
/AgileFlow:contextto generate/refresh context - Use
/AgileFlow:context MODE=exportfor concise excerpt - Paste into web AI tool for research/ideation
- Use
/AgileFlow:context MODE=research TOPIC="..."for structured prompts - Save results with
/AgileFlow:research
Session Harness System (v2.24.0+)
Ensures test verification and session continuity for long-running projects. Prevents agents from breaking functionality and maintains progress across context windows.
The Problem: Without verification, agents can:
- Break existing functionality without noticing
- Claim features work when tests fail
- Lose context between sessions
- Mark incomplete work as finished
The Solution: Session Harness System tracks test status, verifies baselines, and maintains session state.
Quick Start:
# First time setup (interactive)
/AgileFlow:session-init
# Start each session (or auto-run via hook)
/AgileFlow:resume
# Run tests and update test status
/AgileFlow:verify
# Create verified checkpoint
/AgileFlow:baseline "Sprint 12 complete"How It Works:
- Test Tracking: Every story has
test_statusfield (passing/failing/not_run) - Pre-Implementation: Agents check test_status before starting work
- Post-Implementation: Agents run
/AgileFlow:verifybefore marking complete - Session Resume: Loads context and detects regressions
- Baselines: Git tags mark known-good states for reset points
Benefits:
- No Broken Baselines: Agents can't mark stories complete with failing tests
- Fail Fast: Catch regressions immediately, not at PR review
- Context Continuity: Structured handoff between sessions
- Regression Detection: Alerts when tests were passing, now failing
Agent Integration (v2.26.0): All 18 dev agents now include verification protocol:
- ui, api, ci, devops
- security, database, testing
- performance, mobile, integrations
- refactor, design, accessibility
- analytics, datamigration, monitoring
- compliance, qa
Learn More: See CLAUDE.md "Session Harness System" section for complete documentation.
Status.json Compression
Prevent "file too large" errors:
# Compress status.json (removes verbose fields)
/AgileFlow:compress
# Typical result: 80-90% size reductionFull story content remains in docs/06-stories/ markdown files (no data loss).
Examples
Creating an Epic with Stories
/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"Working on a Story
/AgileFlow:assign STORY=US-0001 NEW_OWNER=AG-UI NEW_STATUS=in-progress NOTE="Starting implementation"
# ... do the work ...
/AgileFlow:status STORY=US-0001 STATUS=in-review SUMMARY="Login form complete with tests" PR=https://github.com/...Recording a Decision
/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"Templates
All templates are located in templates/ and docs/00-meta/templates/:
epic-template.md- Epic structurestory-template.md- User story formatadr-template.md- Architecture decision recordagent-profile-template.md- Agent profile and contractcomms-note-template.md- Handoff documentationresearch-template.md- Research note structureREADME-template.md- Folder README template
Contributing
This plugin is designed to be framework-agnostic. Customize templates and commands to fit your team's workflow.
License
MIT
Support
For issues or questions, please visit the GitHub repository.
