Skip to content

CLI_Reference

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

🔧 CLI Reference

Complete reference for all ClaudeAutoPM command-line tools.

📋 Main Commands

autopm install [path]

Install ClaudeAutoPM framework to a project directory.

# Install to current directory
autopm install

# Install to specific directory  
autopm install ~/my-project
autopm install /path/to/project

# Options
--verbose    # Show detailed installation progress
--no-backup  # Skip creating backups (not recommended)

What it does:

  • Detects fresh install vs update mode automatically
  • Creates backups for existing installations
  • Copies framework files (.claude/, .github/, scripts/)
  • Interactive configuration selection (Minimal/Docker/Full DevOps)
  • Generates appropriate CLAUDE.md template
  • Preserves user customizations (.github/, .claude-code/)

Interactive prompts:

🔧 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

autopm update [path]

Update existing ClaudeAutoPM installation.

# Update current project
autopm update

# Update specific project
autopm update ~/my-project

# Same options as install
--verbose --no-backup

What it does:

  • Preserves your configuration settings
  • Updates framework files with new features
  • Protects .github/ and .claude-code/ from overwriting
  • Creates timestamped backups before changes
  • Shows detailed file change reports

autopm config

Interactive configuration tool for feature toggles.

autopm config

Features:

  • Visual display of current configuration
  • Toggle Docker-first development on/off
  • Toggle Kubernetes testing on/off
  • Toggle GitHub Actions integration
  • Load predefined templates (minimal/docker-only/full-devops)
  • Automatic CLAUDE.md regeneration
  • Configuration validation and consistency checks

Interface:

Current Configuration:
🐳 Docker-first development: ✅ ENABLED
☸️ Kubernetes testing: ❌ DISABLED  
🔧 GitHub Actions K8s: ❌ DISABLED
🛡️ Integration tests: ✅ ENABLED

Available Actions:
[1] Toggle Docker-first development
[2] Toggle Kubernetes DevOps testing  
[3] Toggle GitHub Actions K8s
[4] Load template: minimal
[5] Load template: docker-only
[6] Load template: full-devops
[0] Save and exit

autopm setup-env [path]

Interactive environment variable configuration.

# Configure .env for current project
autopm setup-env

# Configure for specific project
autopm setup-env ~/my-project

Configures:

  • MCP (Model Context Protocol) servers
  • Context7 integration
  • GitHub token
  • Playwright browser settings
  • Azure DevOps credentials
  • Cloud provider credentials (AWS, Azure, GCP)
  • AI provider API keys (OpenAI, Gemini)

autopm merge

Generate intelligent CLAUDE.md merge prompts.

autopm merge

Use cases:

  • Resolving conflicts between your CLAUDE.md and framework updates
  • Combining custom rules with new framework features
  • AI-assisted configuration merging

Options:

How would you like to receive the merge prompt?
  1) Print to console
  2) Save to file (merge_prompt.md)

autopm init <project-name>

Initialize new project with ClaudeAutoPM.

# Create new project
autopm init my-awesome-project
cd my-awesome-project

# Project is ready with ClaudeAutoPM installed

What it does:

  • Creates new directory
  • Initializes git repository
  • Installs ClaudeAutoPM framework
  • Interactive configuration selection
  • Sets up .env variables

autopm mcp <command>

Manage MCP (Model Context Protocol) servers.

# Available commands
autopm mcp list          # List all available MCP servers
autopm mcp enable <name> # Enable a server in current project
autopm mcp disable <name> # Disable a server
autopm mcp add           # Add new server interactively
autopm mcp remove <name> # Remove server definition
autopm mcp sync          # Generate mcp-servers.json
autopm mcp validate      # Validate all server definitions
autopm mcp info <name>   # Show detailed server information

Examples:

# Enable GitHub MCP server
autopm mcp enable github-mcp

# List enabled servers
autopm mcp list

# Sync configuration to mcp-servers.json
autopm mcp sync

# Get info about specific server
autopm mcp info context7-docs

Available MCP Servers:

  • context7-docs - Documentation context server
  • context7-codebase - Codebase analysis server
  • github-mcp - GitHub operations server
  • playwright-mcp - Browser automation server
  • filesystem-mcp - File system operations
  • sqlite-mcp - SQLite database operations

🔍 Information Commands

autopm --version / autopm version

Display version information.

autopm --version
# ClaudeAutoPM v1.0.3
# Node.js v20.10.0
# Platform: darwin arm64

autopm --help / autopm help

Show comprehensive help information.

autopm --help
# Shows complete command reference with examples

⚙️ Global Options

These options work with most commands:

--help, -h       # Show command-specific help
--version, -v    # Show version information  
--verbose        # Detailed output with file listings
--no-backup      # Skip backup creation (not recommended)

🎯 Usage Examples

Basic Installation Workflow

# Install globally
npm install -g claude-autopm

# Set up existing project
cd my-existing-project
autopm install
# Choose configuration → Configure .env → Ready!

# Update later
autopm update

New Project Workflow

# Create new project with ClaudeAutoPM
autopm init my-new-project
cd my-new-project

# Configure features
autopm config
# Toggle features as needed

# Set up environment
autopm setup-env
# Enter API keys and credentials

Configuration Management

# View current settings
autopm config

# Switch from Minimal to Docker-only
autopm config
# Select: [6] Load template: docker-only
# CLAUDE.md automatically regenerates!

# Fine-tune individual features
autopm config
# Toggle specific features on/off

Project Updates

# Get latest ClaudeAutoPM version
npm install -g claude-autopm@latest

# Update project with new features
cd my-project
autopm update
# 🔒 Preserving existing configuration
# New features added, settings preserved

🛠️ Advanced Usage

Batch Operations

# Install to multiple projects
for project in project1 project2 project3; do
  autopm install $project
done

CI/CD Integration

# In GitHub Actions
- name: Install ClaudeAutoPM
  run: |
    npm install -g claude-autopm
    autopm install --no-backup

Custom Templates

# Use custom configuration
cp my-custom-config.json .claude/config.json
autopm config  # Validate and apply

📁 File Locations

Global Installation

  • Binary: ~/.npm/bin/autopm (or equivalent)
  • Package: ~/.npm/lib/node_modules/claude-autopm/

Project Installation

  • Configuration: .claude/config.json
  • Environment: .claude/.env
  • Templates: .claude/config-templates/
  • Scripts: .claude/scripts/
  • Generated: CLAUDE.md

🔧 Direct Script Access

For advanced users, you can run scripts directly:

# Configuration toggle script
.claude/scripts/config/toggle-features.sh

# Environment setup script
.claude/scripts/setup-env.sh

# PM initialization script
.claude/scripts/pm/init.sh

🎨 Output Formats

Verbose Mode

autopm install --verbose

# Shows detailed file operations:
▶ Installing: .claude
    📁 Installing directory: .claude
      📋 Files to install: 127
      ➕ agents/AGENT-REGISTRY.md
      ➕ commands/pm/epic-start.md
      ... and 122 more files
✓ Installed: .claude

Standard Mode

autopm install

# Concise output:
📦 Installing ClaudeAutoPM...
✓ Configuration applied
✓ Files installed
✓ CLAUDE.md generated
🎉 Installation complete!

🚨 Error Handling

Common Issues

# Missing dependencies
autopm install
# ❌ Missing requirements: Git
# Solution: Install git first

# Permission issues  
autopm install /protected/path
# ❌ Permission denied
# Solution: Use sudo or choose different path

# Network issues
autopm install  
# ❌ Failed to download from GitHub
# Solution: Check internet connection, try again

Recovery

# Restore from backup
ls .autopm_backup_*
cp -r .autopm_backup_20240113_143022/* .

# Reset configuration
autopm config
# [7] Load template: full-devops

📖 Related Documentation

💡 Tips & Tricks

Performance

  • Use --no-backup for faster updates (only if you have git backup)
  • Use --verbose to debug installation issues

Automation

  • Script installations with predefined configs
  • Use environment variables to skip interactive prompts

Maintenance

  • Run autopm update regularly for new features
  • Use autopm config to explore new capabilities
  • Backup your .claude/config.json for custom setups

Clone this wiki locally