Quick Start - Xavier Framework

Prerequisites

Before you begin, ensure you have:

✅

Python 3.8 or higher - Check with python --version

✅

Claude Code installed - Available from Anthropic

✅

Git installed - Check with git --version

✅

Active project directory - Where you want to use Xavier

Installation Steps

Navigate to Your Project

Open your terminal and navigate to your project directory:

cd /path/to/your/project

Run the Installation Command

Execute the one-line installation script:

curl -sSL https://raw.githubusercontent.com/gumruyanzh/xavier/main/install.sh | bash

This will:

Download Xavier Framework
Set up the .xavier directory structure
Configure Claude Code commands
Initialize configuration files

Verify Installation

Open Claude Code in your project and type:

/xavier-help

You should see a list of available Xavier commands.

Updating Xavier

Keep Xavier up to date with the latest features and improvements:

Check for Updates

Use the Xavier command to check if updates are available:

/xavier-update

This will show your current version and any available updates.

Install Updates

Run the update script to get the latest version:

curl -sSL https://raw.githubusercontent.com/gumruyanzh/xavier/main/update.sh -o xavier-update.sh && \
bash xavier-update.sh && \
rm xavier-update.sh

The update process will:

Backup your existing data
Update framework files
Preserve your stories, tasks, and sprints
Update all Claude Code commands

Current Version: 1.1.14

Latest Features:
• MAJOR: Complete agent system overhaul with /create-agent command
• ALL tasks now show colored agent displays during sprint execution
• Added TestRunner, Ruby, and Java engineer agents
• Smart task delegation ensures every task has a dedicated agent
• Custom agent creation with skills, colors, and emojis
• Epic management system with /create-epic, /add-to-epic, /list-epics
• Enhanced roadmap functionality with /add-to-roadmap command
• Full backward compatibility maintained

Your First Sprint

Let's create a simple TODO application using Xavier's workflow:

📝 Example: TODO App with Authentication

Step 1: Create User Stories

# Story for authentication
/create-story "As a user, I want to register and login" 8

# Story for TODO management
/create-story "As a user, I want to manage my todos" 13

Step 2: Break Down into Tasks

# Authentication tasks
/create-task "Create user model with validation" STORY-001 3
/create-task "Implement registration endpoint" STORY-001 5
/create-task "Implement login with JWT" STORY-001 5

# TODO tasks
/create-task "Create TODO model" STORY-002 2
/create-task "Implement CRUD endpoints" STORY-002 8
/create-task "Add user authorization" STORY-002 3

Step 3: Plan Your Sprint

# Create a 2-week sprint
/create-sprint "Sprint 1: Core Features" 14

# View your backlog
/show-backlog

Step 4: Start Development

# Start the sprint - Xavier will guide you through TDD
/start-sprint SPRINT-001

🎯 What Happens Next?

Xavier will:
1. Start with the highest priority task
2. Require you to write tests first (TDD)
3. Validate 100% test coverage
4. Enforce Clean Code standards
5. Process tasks sequentially
6. Track your velocity and progress

Configuration Options

Xavier creates a configuration file at .xavier/config.json. Here are key settings you might want to adjust:

{
  "test_coverage_threshold": 100,      // Minimum coverage required
  "max_function_lines": 20,            // Clean Code function limit
  "max_class_lines": 200,              // Clean Code class limit
  "sprint_duration_days": 14,          // Default sprint length
  "enforce_sequential": true,          // No parallel tasks
  "test_first": true                   // TDD enforcement
}

Common Workflows

🐛 Handling Bugs

# Report a bug
/create-bug "Login fails with special characters" HIGH "STORY-001"

# Bugs are automatically prioritized in the backlog

📊 Sprint Progress

# Check current sprint status
/show-backlog

# Xavier shows:
# - Completed story points
# - Remaining tasks
# - Current velocity
# - Burn-down progress

🔄 Mid-Sprint Changes

# Add urgent task to current sprint
/create-task "Fix critical security issue" STORY-001 5 CRITICAL

# Xavier will re-prioritize automatically

Best Practices

💡

Start Small: Begin with 3-5 story points for your first sprint to understand Xavier's workflow

💡

Write Clear Stories: Use the standard format: "As a [user], I want to [action] so that [benefit]"

💡

Estimate Conservatively: It's better to under-promise and over-deliver

💡

Trust the Process: Let Xavier enforce TDD and Clean Code - it leads to better quality

💡

Review Regularly: Check velocity after each sprint to improve estimates

Troubleshooting

❌ Commands Not Showing in Claude Code

Ensure the .claude/commands/ directory exists and contains the command files. Re-run the installation script if needed.

❌ Python Version Error

Xavier requires Python 3.8+. Update your Python installation or use pyenv to manage versions.

❌ Installation Failed

Check that you have internet connectivity and can access GitHub. Try manual installation:

git clone https://github.com/gumruyanzh/xavier.git
cd xavier
./install.sh /path/to/your/project

❌ Tests Failing

Xavier enforces 100% coverage. Ensure all code paths are tested, including error cases and edge conditions.

Quick Start Guide