Installation
How to install AgileFlow in your project
Installation
This guide will walk you through installing AgileFlow in your development environment.
Quick Installation
The fastest way to get started with AgileFlow is using the install command:
This command will set up AgileFlow in your current directory and create all necessary configuration files.
What Gets Installed
The installation process will create the following structure in your project:
Installation Steps
Configure Settings
The installer will prompt you for configuration options:
- Project name
- Default sprint duration
- Team velocity (optional)
- Git integration preferences
Verify Installation
Check that AgileFlow is installed correctly:
You should see the configuration files listed above.
Manual Installation
If you prefer to install manually:
-
Create directories:
-
Create config file: Create
.agileflow/config.json: -
Install commands: Copy command files to
.claude/commands/
Verifying Installation
To verify that AgileFlow is installed correctly, try running:
You should see a list of available commands and agents.
Next Steps
After installation:
- Complete the Quick Start tutorial
- Read about Core Concepts
- Explore the Commands Reference
AgileFlow works best when integrated with your IDE. Make sure you're using Claude Code, Cursor, or Windsurf.
Troubleshooting
Command not found
If commands aren't recognized:
- Ensure
.agileflow/is in your project root - Restart your IDE
- Check file permissions
Configuration errors
If you see configuration errors:
- Verify
config.jsonis valid JSON - Check that all required fields are present
- Review the Configuration Guide
Uninstalling
To remove AgileFlow:
This will delete all your epics, stories, and configuration. Make sure to backup any important data first.