Quick Start

Get up and running with AgileFlow in just a few minutes. This tutorial will guide you through creating your first user story.

Your First Story

Let's create a simple user story for adding a login feature.

/AgileFlow:story

I need a login page where users can sign in with email and password

cat .agileflow/stories/AF-001-user-login.md

/AgileFlow:status AF-001 in-progress

Understanding the Workflow

AgileFlow follows a structured workflow:

graph LR
    A[Create Story] --> B[Plan Sprint]
    B --> C[Implement]
    C --> D[Review]
    D --> E[Deploy]

1. Create Stories

Use /AgileFlow:story to create user stories with:

• Clear acceptance criteria
• Story point estimates
• Dependencies

2. Plan Sprints

Organize stories into sprints:

/AgileFlow:sprint

This helps you:

• Group related stories
• Calculate team capacity
• Track velocity

3. Implement Features

As you develop:

• Update story status
• Document decisions with ADRs
• Track progress

4. Review & Deploy

Before deployment:

• Run automated tests
• Create pull requests
• Generate changelogs

Example Workflow

Here's a complete workflow example:

# 1. Create a story
/AgileFlow:story
> "Add user authentication with JWT tokens"
 
# 2. Plan the sprint
/AgileFlow:sprint
> Add AF-001 to current sprint
 
# 3. Start development
/AgileFlow:status AF-001 in-progress
 
# 4. Document an architecture decision
/AgileFlow:adr
> "Use JWT for authentication because..."
 
# 5. Complete the story
/AgileFlow:status AF-001 completed
 
# 6. Create a pull request
/AgileFlow:pr AF-001

Common Commands

Here are the most frequently used commands:

Working with Agents

AgileFlow includes 26 specialized agents. Here are some examples:

API Agent

For backend work:

@agileflow-api implement the login endpoint for AF-001

The API agent will:

• Create the endpoint
• Add validation
• Write tests
• Document the API

UI Agent

For frontend work:

@agileflow-ui create the login form component for AF-001

The UI agent will:

• Build the component
• Add accessibility
• Style with your design system
• Write component tests

Testing Agent

For comprehensive testing:

@agileflow-testing create test suite for AF-001

Best Practices

1. Write Clear Descriptions: The better your description, the better AgileFlow can help
2. Break Down Large Features: Use epics to organize complex features
3. Update Status Regularly: Keep your story status current
4. Document Decisions: Use ADRs for important technical decisions
5. Review Generated Content: Always review and adjust AI-generated stories

Next Steps

Now that you've created your first story:

1. Explore Core Concepts to understand AgileFlow's workflow
2. Browse the Commands Reference for all available commands
3. Learn about Agents to automate more tasks
4. Check out Sprint Planning for team collaboration

Getting Help

Need assistance?

• Check the documentation
• Visit the GitHub repo
• Review Configuration options