AgileFlow Docs

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:

npx @xloxn69/agileflow install

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:

.agileflow/
├── config.json          # Main configuration
├── epics/              # Epic definitions
├── stories/            # User stories
└── .meta/              # Metadata and state

.claude/
├── commands/           # Custom slash commands
└── agents/             # Agent configurations

Installation Steps

Initialize AgileFlow

Run the install command in your project root:

npx @xloxn69/agileflow install

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:

ls -la .agileflow/

You should see the configuration files listed above.

Manual Installation

If you prefer to install manually:

  1. Create directories:

    mkdir -p .agileflow/{epics,stories,.meta}
    mkdir -p .claude/{commands,agents}
  2. Create config file: Create .agileflow/config.json:

    {
      "version": "1.0.0",
      "projectName": "My Project",
      "sprintDuration": 14,
      "velocityTracking": true
    }
  3. Install commands: Copy command files to .claude/commands/

Verifying Installation

To verify that AgileFlow is installed correctly, try running:

/AgileFlow:help

You should see a list of available commands and agents.

Next Steps

After installation:

  1. Complete the Quick Start tutorial
  2. Read about Core Concepts
  3. 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.json is valid JSON
  • Check that all required fields are present
  • Review the Configuration Guide

Uninstalling

To remove AgileFlow:

rm -rf .agileflow .claude

This will delete all your epics, stories, and configuration. Make sure to backup any important data first.

On this page