Skip to content
On this page

๐Ÿš€ 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

bash
# Install ClaudeAutoPM globally
npm install -g claude-autopm

# Install to your project
cd your-project
autopm install

# You're ready! ๐ŸŽ‰

No-Install Option

bash
# 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

bash
# 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

bash
# 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

bash
# 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:

bash
# 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)

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

2. Break it into an Epic

bash
/pm:epic-decompose

3. Generate GitHub Issues

bash
/pm:epic-sync

4. Start Development

bash
/pm:next  # Get AI-recommended next task

5. Use AI Agents

bash
# 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

bash
# 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

bash
# 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

bash
# 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

bash
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)

bash
/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! ๐Ÿš€

Released under the MIT License.