Skip to content

Quick_Start

Jump to bottom
Rafal Lagowski edited this page Sep 14, 2025 · 2 revisions

🚀 Quick Start Guide

Get ClaudeAutoPM up and running in your project in just 5 minutes!

✨ What's New in v1.1.0

  • 🔄 Unified Commands - Same commands work for GitHub, Azure DevOps, and more
  • ⚡ 40% Faster - With intelligent caching and optimizations
  • 🧪 94% Test Coverage - Production-ready reliability
  • 📊 Self-Maintaining - Built-in health checks and optimization tools

⚡ 1-Minute Installation

Global Installation (Recommended)

# Install ClaudeAutoPM globally
npm install -g claude-autopm

# Install to your project
cd your-project
autopm install

# You're ready! 🎉

No-Install Option

# Use without installing globally
npx autopm install

🎯 Choose Your Configuration

During installation, you'll choose your development style:

🔧 Choose your development configuration:
  1) 🏃 Minimal     - Traditional development (no Docker/K8s)
  2) 🐳 Docker-only - Docker-first development without Kubernetes  
  3) 🚀 Full DevOps - All features (Docker + Kubernetes + CI/CD)
  4) ⚙️  Custom     - Use existing config.json template

Your choice [1-4]:

Quick Decision Guide

  • New to containers? → Choose Minimal (1)
  • Team consistency needed? → Choose Docker-only (2)
  • Enterprise/production app? → Choose Full DevOps (3)

📁 What Gets Installed

After installation, your project will have:

your-project/
├── .claude/                 # ClaudeAutoPM configuration
│   ├── agents/             # 50+ AI agents
│   ├── rules/              # Development workflows
│   ├── commands/           # PM commands
│   ├── config.json         # Your chosen configuration
│   └── .env                # Environment variables
├── .claude-code/           # Claude Code settings
├── .github/                # GitHub Actions workflows
├── scripts/                # Automation scripts  
├── CLAUDE.md              # AI instructions (auto-generated)
├── PLAYBOOK.md            # Usage guide
└── COMMIT_CHECKLIST.md    # Quality standards

🛠️ Verify Installation

# Check your configuration
autopm --version

# View current settings
autopm config

# Test AI agent
# In Claude Code, try the new unified commands:
/pm:issue:list
/pm:help

🎨 Customize Your Setup

Change Configuration Anytime

# Interactive configuration tool
autopm config

# Switch from Minimal to Docker-only
# Toggle Docker-first development: OFF → ON
# Your CLAUDE.md automatically updates!

Configure Environment Variables

# Interactive .env setup
autopm setup-env

# Or copy and edit manually
cp .claude/.env.example .claude/.env
nano .claude/.env

🚦 Your First ClaudeAutoPM Workflow

New Unified Commands (v1.1.0)

All commands now use the /pm:resource:action format:

# List open issues (works with ANY provider!)
/pm:issue:list --status=open

# Start working on an issue
/pm:issue:start 123

# Create a pull request
/pm:pr:create --title="Feature: Add caching"

# Check project health
npm run pm:health

1. Create a PRD (Product Requirements Document)

# In Claude Code
/pm:prd-new "User Authentication System"

2. Break it into an Epic 

/pm:epic-decompose

3. Generate GitHub Issues 

/pm:epic-sync

4. Start Development 

/pm:next  # Get AI-recommended next task

5. Use AI Agents 

# For React frontend
Task: Create login form with validation
Agent: react-frontend-engineer

# For Python backend  
Task: Create FastAPI authentication endpoint
Agent: python-backend-engineer

# For testing
Task: Write E2E tests for login flow
Agent: playwright-test-engineer

📋 Configuration-Specific Workflows

🏃 Minimal Configuration

# Standard development
npm install
npm run dev
npm test

# AI assistance with native tools
Task: Fix authentication bug
Agent: javascript-frontend-engineer

🐳 Docker-Only Configuration

# Container-first development
docker compose up -d
docker compose exec app npm install
docker compose exec app npm run dev

# AI assistance with Docker
Task: Optimize Dockerfile for Node.js
Agent: docker-expert

🚀 Full DevOps Configuration

# Local development (Docker)
docker compose up -d
docker compose exec app npm run dev

# CI/CD happens automatically via GitHub Actions
# - Kubernetes testing with KIND
# - Security scanning
# - Helm chart validation

# AI assistance with K8s
Task: Create Kubernetes deployment manifests  
Agent: kubernetes-orchestrator

🔧 Essential Commands

Project Management

autopm install              # Install ClaudeAutoPM framework
autopm config               # Configure features interactively
autopm update               # Update to latest version
autopm setup-env            # Configure environment variables
autopm merge                # Merge CLAUDE.md configurations

In Claude Code (PM Commands)

/pm:init                    # Initialize PM system
/pm:next                    # Get next recommended task  
/pm:status                  # View project status
/pm:epic-start "Epic Name"  # Start new epic
/azure:standup              # Daily standup (if using Azure DevOps)

🎯 Next Steps by Configuration

If you chose Minimal:

  1. Read PLAYBOOK.md for basic workflows
  2. Learn about AI Agents
  3. Try the PM commands
  4. When ready, consider upgrading to Docker-only

If you chose Docker-only:

  1. Learn Docker-First Development
  2. Set up your docker-compose.yml
  3. Configure hot reload
  4. Explore container-aware agents

If you chose Full DevOps:

  1. Understand the Hybrid Strategy
  2. Set up Kubernetes manifests
  3. Configure Helm charts
  4. Review GitHub Actions workflows

🤝 Getting Help

Documentation

Community

🎉 You're Ready!

Your ClaudeAutoPM installation is complete! Here's what to do next:

  1. Explore your CLAUDE.md - See how it matches your configuration
  2. Try a PM command - Start with /pm:help in Claude Code
  3. Create your first epic - Use /pm:epic-start "Your Epic Name"
  4. Get familiar with agents - Check the Agent Registry

Happy coding with ClaudeAutoPM! 🚀

Clone this wiki locally