Appearance
๐ 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)
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:
- Read PLAYBOOK.md for basic workflows
- Learn about AI Agents
- Try the PM commands
- When ready, consider upgrading to Docker-only
If you chose Docker-only:
- Learn Docker-First Development
- Set up your docker-compose.yml
- Configure hot reload
- Explore container-aware agents
If you chose Full DevOps:
- Understand the Hybrid Strategy
- Set up Kubernetes manifests
- Configure Helm charts
- Review GitHub Actions workflows
๐ค Getting Help
Documentation
- Configuration Options - Detailed config guide
- CLI Reference - All commands
- Troubleshooting - Common issues
Community
- ๐ Found a bug? Report on GitHub
- ๐ฌ Have questions? GitHub Discussions
- ๐ Improve docs Edit this wiki
๐ You're Ready!
Your ClaudeAutoPM installation is complete! Here's what to do next:
- Explore your CLAUDE.md - See how it matches your configuration
- Try a PM command - Start with
/pm:help
in Claude Code - Create your first epic - Use
/pm:epic-start "Your Epic Name"
- Get familiar with agents - Check the Agent Registry
Happy coding with ClaudeAutoPM! ๐