amplihack¶
Agentic coding framework for Claude Code, Microsoft Amplifier, GitHub Copilot CLI, and Codex that uses specialized AI agents to accelerate software development through intelligent automation and collaborative problem-solving.
What is amplihack?¶
amplihack is a development framework for popular coding agent systems (Claude Code, Microsoft Amplifier, GitHub Copilot CLI, and Codex) that leverages multiple specialized AI agents working together to handle complex software development tasks. It combines ruthless simplicity with powerful capabilities to make AI-assisted development more effective and maintainable.
Quick Navigation¶
New to amplihack? Start here:
- Get Started - Installation and first steps
- Core Concepts - Philosophy and principles
- Amplihack Tutorial - Comprehensive 60-90 minute tutorial
Looking for something specific?
- Commands & Operations - Execute complex tasks
- Workflows - Structured development processes
- Agents & Tools - Specialized AI capabilities
- Troubleshooting - Fix common issues
π Get Started¶
Everything you need to install and configure amplihack.
Choose Your Tool¶
amplihack works with multiple agentic coding tools. Choose the one that fits your workflow:
# Launch with Claude Code (default)
uvx --from git+https://github.com/rysweet/amplihack amplihack claude
# Launch with Microsoft Amplifier
uvx --from git+https://github.com/rysweet/amplihack amplihack amplifier
# Launch with GitHub Copilot CLI
uvx --from git+https://github.com/rysweet/amplihack amplihack copilot
Tool Compatibility Matrix:
| Feature | Claude Code | Amplifier | Copilot CLI | Codex |
|---|---|---|---|---|
| Plugin Architecture | β Yes | β No | β No | β No |
| Per-Project Staging | β Yes | β Yes | β Yes | β Yes |
| All Agents (38) | β Yes | β Yes | β Yes | β οΈ Limited |
| All Skills (73) | β Yes | β Yes | β Yes | β οΈ Limited |
| All Commands (24) | β Yes | β Yes | β Yes | β οΈ Limited |
| Workflows | β All | β All | β All | β οΈ Limited |
| Auto Mode | β Yes | β Yes | β Yes | β οΈ Limited |
New to amplihack? After launching, try the interactive tutorial:
The guide agent will walk you through workflows, prompting strategies, and hands-on exercises (60-90 minutes).
Plugin Architecture β NEW¶
Centralized plugin system that works across all your projects:
- Plugin Installation Guide - Install amplihack as a global plugin (Claude Code only)
- Plugin Architecture Overview - How the plugin system works
- Migration Guide - Migrate from per-project to plugin mode
- CLI Reference - Complete command-line reference
Note: Plugin architecture is Claude Code only. Microsoft Amplifier, GitHub Copilot CLI, and Codex use per-project ~/.amplihack/.claude/ staging instead.
Installation¶
- Prerequisites - System requirements and dependencies
- Interactive Installation - Step-by-step setup wizard
- Quick Start - Basic usage and first commands
Configuration¶
Tool-Specific Setup¶
Claude Code (Default)
- Requires:
$ANTHROPIC_API_KEYenvironment variable for Anthropic models - Plugin mode: Install globally with Plugin Installation Guide
- Per-project mode: Copy
~/.amplihack/.claude/directory to your project - Azure OpenAI: Use proxy configuration (see Proxy Configuration)
Microsoft Amplifier
Amplifier walks you through model configuration on first startup. Supports all Amplifier-compatible models including Claude, GPT-4, and local models.
GitHub Copilot CLI
- Uses GitHub Copilot models (switch with
/modelcommand) - Adaptive hooks enable preference injection and context loading
- All 38 agents available via
--agent <name>flag - See GitHub Copilot Integration for complete guide
Codex
- Limited support via per-project
~/.amplihack/.claude/staging - Most features work but may require adaptation
- Tested primarily with Claude models
General Configuration¶
- Profile Management - Multiple environment configurations
- Proxy Configuration - Network proxy setup (Azure OpenAI, custom endpoints)
- Hook Configuration - Customize framework behavior
- Memory Configuration Consent - Intelligent memory settings with timeout protection
- Verify .claude/ Staging - Check that framework files are properly staged
- Verify Framework Injection - Check that AMPLIHACK.md injection is working
Deployment¶
- UVX Deployment - Deploy with uvx
- UVX Data Models - Understanding uvx data structures
- Azure Integration - Deploy to Azure cloud
π‘ Core Concepts¶
Understand the philosophy and architecture behind amplihack.
Philosophy & Principles¶
- Development Philosophy - Ruthless simplicity and modular design
- This Is The Way - Best practices and patterns
- Workspace Pattern - Organize your development environment
- Trust & Anti-Sycophancy - Honest agent behavior
Architecture¶
- Project Overview - System architecture
- Development Patterns - Proven implementation patterns
- Unified Staging Architecture - How .claude/ staging works across all commands
- Framework Injection Architecture - How AMPLIHACK.md injection works
- How to Use Blarify Code Graph - Enable, query, and configure
- Blarify Architecture - Understanding the Blarify integration
- Documentation Knowledge Graph - How docs connect
Key Features¶
- Modular Design - Self-contained modules (bricks & studs)
- Zero-BS Implementation - No stubs or placeholders
- Specialized AI Agents - Purpose-built for each task
- Structured Workflows - Proven methodologies
π Workflows¶
Proven methodologies for consistent, high-quality results.
Automatic Workflow Classification β NEW¶
Mandatory at Session Start (Issue #2353) - amplihack now automatically classifies your request and executes the appropriate workflow when you start a session:
- 4-Way Classification: Q&A, Operations, Investigation, or Development
- Recipe Runner Execution: Code-enforced workflow steps with fail-fast behavior
- Graceful Fallback: Recipe Runner β Workflow Skills β Markdown
- Explicit Command Bypass: Commands like
/fix,/analyzeskip auto-classification
Quick Reference: | Your Request | Classified As | Workflow | Steps | |--------------|---------------|----------|-------| | "What is..." | Q&A | Direct answer | 3 | | "Clean up..." | Operations | Direct execution | 1 | | "How does X work?" | Investigation | Deep exploration | 6 | | "Add feature X" | Development | Full workflow | 23 |
Implementation: src/amplihack/workflows/ - classifier, execution_tier_cascade, session_start modules
Core Workflows¶
- Default Workflow - Standard multi-step development process
- Investigation Workflow - Deep codebase analysis and understanding
- Document-Driven Development (DDD) - Documentation-first approach for large features
DDD Deep Dive¶
Document-Driven Development is a systematic methodology where documentation comes first and acts as the specification.
- Core Concepts
- Overview - What is DDD and when to use it
- Core Concepts - File crawling, context poisoning, retcon writing
- File Crawling - Systematic file processing
- Context Poisoning - Preventing inconsistencies
-
Retcon Writing - Present-tense documentation
-
Implementation Phases
- Phase 0: Planning - Define scope and objectives
- Phase 1: Documentation - Write the spec
- Phase 2: Approval - Review and validate
- Phase 3: Code Planning - Implementation strategy
- Phase 4: Implementation - Build it
- Phase 5: Testing - Verify behavior
-
Phase 6: Cleanup - Final touches
-
Reference
- Reference Materials - Practical resources
- Checklists - Phase verification
- Tips for Success - Best practices
- Common Pitfalls - What to avoid
- FAQ - Common questions
Recipe Runner¶
Code-enforced workflow execution engine with declarative YAML recipes.
- Recipe Runner Overview - Architecture, YAML format, and creating custom recipes
- UltraThink Recipe Runner Integration - How ultrathink uses Recipe Runner for code-enforced workflow execution
- Recipe CLI Commands How-To - Task-oriented guide for using recipe commands
- Recipe CLI Reference - Complete command-line documentation
Quick Start:
# List available recipes
amplihack recipe list
# Execute a workflow recipe
amplihack recipe run default-workflow \
--context '{"task_description": "Add user authentication", "repo_path": "."}'
# Validate recipe YAML
amplihack recipe validate my-workflow.yaml
# Show recipe details
amplihack recipe show default-workflow
Advanced Workflows¶
- N-Version Programming - Multiple solutions for critical code
- Multi-Agent Debate - Structured decision-making
- Cascade Workflow - Graceful degradation patterns
π€ Agents & Tools¶
Specialized AI agents and tools for every development task.
Core Agents¶
- Architect - System design and specifications
- Builder - Code implementation from specs
- Reviewer - Quality assurance and compliance
- Tester - Test generation and validation
Specialized Agents¶
- API Designer - Contract definitions
- Security Agent - Vulnerability assessment
- Database Agent - Schema and query optimization
- Integration Agent - External service connections
- Cleanup Agent - Code simplification
Goal-Seeking Agents¶
Autonomous agents that learn, remember, teach, and apply knowledge across four SDK backends.
π Tutorials (Learning-Oriented)
- Goal-Seeking Agent Tutorial - Interactive 10-lesson tutorial covering agent generation, SDK selection, multi-agent architecture, evaluations (L1-L12), and self-improvement loops
π How-To Guides (Problem-Oriented)
- Goal Agent Generator Guide - Create custom goal-seeking agents with
amplihack new - SDK Adapters Guide - Choose and configure Copilot, Claude, Microsoft, or Mini SDK backends
π Reference (Information-Oriented)
- Quick Reference Card - Fast lookup: commands, SDK selection, eval levels, common patterns
- Eval System Architecture - Progressive test suite (L1-L12), grading pipeline, domain agents, long-horizon memory eval, self-improvement runner
- Goal Agent Generator Design - Architecture and design patterns
- Goal Agent Requirements - Technical specifications
- Implementation Summary - Current implementation status
π‘ Explanation (Understanding-Oriented)
- Comprehensive Guide - Complete system overview: capabilities, architecture, memory systems, evaluation framework, and self-improvement
- Goal Agent Generator Presentation - High-level concept introduction
Key Features:
- SDK-Agnostic: Write once, run on Copilot, Claude, Microsoft Agent Framework, or lightweight mini-framework
- 7 Learning Tools: learn, search, explain, verify, find gaps, store, summary
- Progressive Eval (L1-L12): From simple recall to far transfer across domains
- 3-Run Median Eval:
--runs 3for stable benchmarks (reduces LLM stochasticity) - Multi-Vote Grading:
--grader-votes 3for noise reduction on ambiguous answers - Teaching Evaluation: Multi-turn teacher-student knowledge transfer (Chi 1994, Vygotsky ZPD)
- Self-Improvement Loop: EVAL -> ANALYZE -> RESEARCH -> IMPROVE -> RE-EVAL -> DECIDE with automated error analysis
- 5 Domain Agents: Code Review, Meeting Synthesizer, Data Analysis, Document Creator, Project Planning
- Long-Horizon Memory Eval: 1000-turn dialogue stress test
- Multi-SDK Comparison: 4-way eval comparison via
sdk_eval_loop.py - Current Score: 97.5% overall median (L1-L7, 3-run median, mini SDK)
Memory-Enabled Agents β NEW¶
Learning agents that improve through experience and persist knowledge across sessions.
- Feature Overview - What are memory-enabled agents and when to use them
- Getting Started Tutorial - Create and run your first learning agent (30 minutes)
- API Reference - Complete technical documentation for amplihack-memory-lib
- Architecture Deep-Dive - System design and technical details
- How-To: Integrate Memory - Add memory to existing agents
- How-To: Design Learning Metrics - Track domain-specific improvements
- How-To: Validate Learning - Test learning behavior with gadugi-agentic-test
Key Features:
- Standalone Library:
pip install amplihack-memory-lib- Use in any Python project - Persistent Memory: SQLite-based storage (no external database required)
- Pattern Recognition: Automatically recognize recurring situations after 3 occurrences
- Learning Metrics: Track runtime improvement, pattern recognition rate, confidence growth
- Four Experience Types: SUCCESS, FAILURE, PATTERN, INSIGHT
- Validated Learning: Test-driven validation ensures agents actually learn
Demonstration Agents:
- Documentation Analyzer - Learns documentation quality patterns (MS Learn integration)
- Code Pattern Recognizer - Identifies reusable code patterns and abstractions
- Bug Predictor - Predicts likely bug locations based on learned characteristics
- Performance Optimizer - Learns performance anti-patterns and optimization techniques
Meta-Agentic Task Delegation β NEW¶
Run AI agents in isolated subprocess environments with automatic validation and evidence collection.
- Meta-Delegation Overview - What is meta-delegation and when to use it
- Tutorial - Learn meta-delegation step-by-step (30 minutes)
- How-To Guide - Common tasks and recipes
- API Reference - Complete technical documentation
- Concepts - Architecture and design principles
- Troubleshooting - Fix common issues
Key Feature: Delegate complex tasks to specialized personas (guide, QA engineer, architect, junior developer) running in isolated environments. The system monitors execution, collects evidence, validates success criteria, and provides detailed reports.
Workflow Agents¶
- Ambiguity Handler - Clarify unclear requirements
- Optimizer - Performance improvements
- Pattern Recognition - Identify reusable solutions
Claude Code Skills¶
Modular, on-demand capabilities that extend amplihack:
- Skills Catalog - Complete skills catalog
- Mermaid Diagrams - Visual documentation
- Test Gap Analyzer - Find untested code
- Code Smell Detector - Identify anti-patterns
Scenario Tools¶
Production-ready executable tools following the Progressive Maturity Model:
- Scenario Tools Overview - Progressive maturity model
- Create Your Own Tools - Build custom tools
- Agent Bundle Generator - Package agents for distribution
Available Tools¶
- check-broken-links - Automated link checker for documentation sites and markdown files
- Check GitHub Pages sites or local documentation
- Catch broken internal links and dead external URLs
- Integrates with Makefile:
make check-broken-links TARGET=<url-or-path> -
Returns exit codes for CI integration
-
Platform Bridge - Multi-platform support for GitHub and Azure DevOps
- Automatic platform detection from git remotes
- Unified API for both GitHub and Azure DevOps
- Zero configuration required
- Used by DEFAULT_WORKFLOW for cross-platform compatibility
β‘οΈ Commands & Operations¶
Execute complex tasks with simple slash commands.
Command Reference¶
- Command Selection Guide - Choose the right command for your task
- Amplifier Command - Launch Amplifier with amplihack bundle
Core Commands¶
/ultrathink- Main orchestration command (reads workflow, orchestrates agents)/analyze- Comprehensive code review for philosophy compliance/improve- Capture learnings and self-improvement/fix- Intelligent fix workflow for common error patterns
Document-Driven Development Commands¶
/ddd:0-help- Get help and understand DDD/ddd:prime- Prime context with DDD overview/ddd:1-plan- Phase 0: Planning & Alignment/ddd:2-docs- Phase 1: Documentation Retcon/ddd:3-code-plan- Phase 3: Implementation Planning/ddd:4-code- Phase 4: Code Implementation/ddd:5-finish- Phase 5: Testing & Phase 6: Cleanup/ddd:status- Check current phase and progress
Advanced Commands¶
/amplihack:n-version <task>- Generate N independent solutions for critical code/amplihack:debate <question>- Multi-agent structured debate for decisions/amplihack:cascade <task>- Fallback cascade for resilient operations/amplihack:customize- Manage user preferences and settings
Auto Mode¶
- Auto Mode Guide - Autonomous multi-turn execution
- Auto Mode Safety - Safety guardrails and best practices
- Passthrough Mode - Direct API access
π§ Memory & Knowledge¶
Persistent memory systems and knowledge management.
5-Type Memory System β NEW¶
Psychological memory model with episodic, semantic, procedural, prospective, and working memory:
- 5-Type Memory Guide - Complete user guide
- Developer Reference - Architecture and API
- Quick Reference - One-page cheat sheet
- KΓΉzu Memory Schema - Graph database design for 5 memory types
- KΓΉzu Code Schema - Code graph schema for memory-code linking
- Terminal Visualization - View graph in terminal
- Memory System Overview - Complete memory documentation
Memory Systems¶
- Agent Memory Integration - How agents share and persist knowledge
- Agent Memory Quickstart - Get started with memory
- Agent Type Memory Sharing - Patterns for memory collaboration
Kuzu Memory System¶
Embedded graph-based memory using Kuzu (NO Neo4j required):
- Documentation Graph - Navigate documentation connections
- Code Context Injection - Link code to memories
Code Graph¶
Query your codebase structure via the Kuzu graph database:
- How to Use Blarify Code Graph - Enable, query, and configure
python -m amplihack.memory.kuzu.query_code_graph stats
python -m amplihack.memory.kuzu.query_code_graph search <name>
python -m amplihack.memory.kuzu.query_code_graph functions --file <path>
Historical Research (Neo4j was replaced with Kuzu in Week 7):
Memory Testing¶
- A/B Test Summary - Performance comparisons
- A/B Test Quick Reference - Test results at a glance
- Effectiveness Test Design - How we measure success
- Final Cleanup Report - Memory system cleanup
External Knowledge¶
- External Knowledge Integration - Import external data sources
Blarify Code Indexing¶
Complete code indexing and analysis with multi-language support:
- How to Use Blarify Code Graph - Enable, query, and configure code graph indexing
- Blarify Integration - Technical integration details
- Blarify Quickstart - Get started in 5 minutes
π§ Features & Integrations¶
Specific features and third-party integrations.
Native Binary Trace Logging β NEW¶
Optional request/response logging using Anthropic's native Claude binary:
- Native Binary Trace Logging Overview - Complete feature documentation hub
- Trace Logging Feature Guide - What it is and when to use it
- How-To: Trace Logging - Practical recipes
- Migration: claude-trace to Native - Upgrade from NPM package
- API Reference: Trace Logging - Technical details
- Troubleshooting: Trace Logging - Fix common issues
Key Features: Zero overhead when disabled (<0.1ms), automatic security sanitization, session-scoped JSONL logs, no NPM dependencies.
Power Steering¶
Intelligent guidance system that prevents common mistakes:
- Power Steering Overview - What is Power Steering
- Configuration Guide - Complete configuration reference
- Customization Guide - Customize considerations
- Troubleshooting - Fix common issues
- Migration Guide v0.9.1 - Upgrade guide
- Changelog v0.9.1 - Infinite loop fix release notes
Compaction Handling β NEW
Robust handling of conversation compaction in long sessions:
- Compaction Overview - What is compaction and how power-steering handles it
- Compaction API Reference - Developer documentation for CompactionValidator and CompactionContext
- How to Customize Power Steering - Configuration and troubleshooting
Other Features¶
- Smart Memory Management - Automatic Node.js memory optimization for Claude Code
- Claude.md Preservation - Preserve custom instructions
Third-Party Integrations¶
- GitHub Copilot via LiteLLM - Use Copilot with amplihack
- OpenAI Responses API - OpenAI integration patterns
- MCP Evaluation - Model Context Protocol evaluation
βοΈ Configuration & Deployment¶
Advanced configuration, deployment patterns, and environment management.
Configuration¶
- Profile Management - Multiple environment configurations
- Proxy Configuration - Network proxy setup
- Hook Configuration - Customize framework behavior
- Shell Command Hook - Custom shell integrations
Deployment¶
- UVX Deployment Solutions - Production deployment with uvx
- UVX Data Models - Understanding uvx data structures
- Azure Integration - Deploy to Azure cloud
- Test Azure Proxy - Validate Azure proxy setup
Build System¶
- Plugin Directory Structure Fix - Automatic plugin discovery for UVX installations
Remote Sessions¶
- Remote Sessions Overview - Execute on remote machines
- Remote Session Architecture - How remote execution works
- Remote Session Security - Secure remote operations
π§ͺ Testing & Quality¶
Testing strategies, quality assurance, and validation patterns.
Testing¶
- Benchmarking - Performance measurement and comparison
- Test Gap Analyzer - Find untested code
- CS Validator - Code style validation
- Testing Strategies - Comprehensive testing guide
Code Review¶
- Code Review Guide - Review process and standards
- Memory Code Review - Example: Memory system review
- Workflow Completion - Checklist for finishing features
π Security¶
Security guidelines, context preservation, and best practices.
Security Documentation¶
- Security Recommendations - Essential security practices
- Security Context Preservation - Maintain security through sessions
- Security Guides - Comprehensive security documentation
Safe Operations¶
- Auto Mode Safety - Autonomous operation guardrails
- Passthrough Mode - Direct API access patterns
π οΈ Troubleshooting & Discoveries¶
Fix common issues and learn from past solutions.
Troubleshooting¶
- Discoveries - Known issues and solutions (CHECK HERE FIRST!)
- Troubleshooting Guides - Common problems and fixes
- Memory Consent Issues - Fix prompt, timeout, and detection problems
- Memory-Enabled Agents Issues - Fix memory persistence, pattern recognition, and learning problems
- Platform Bridge Troubleshooting - Fix platform detection and CLI issues
- Stop Hook Exit Hang - Fix 10-13s hang on exit (resolved v0.9.1)
- Tool Null Name Analysis - Debugging tool name issues
- Config Analysis Report - Configuration problem diagnosis
Documentation Guides¶
- Documentation Guidelines - Writing effective docs
- Documentation Structure Analysis - Current state of docs
- How to Generate GitHub Pages - Publish your docs
How-To Guides¶
- Exception Handling - Implement proper error handling in amplihack code
- Configure Memory Consent - Customize prompt behavior, timeouts, and CI/CD integration
- Configure Power-Steering Merge Preferences - Set up merge approval workflow
- Platform Bridge Quick Start - Learn the basics in 10 minutes
- Platform Bridge Workflows - Common workflows for GitHub and Azure DevOps
π¬ Research & Advanced Topics¶
Cutting-edge research, experimental features, and deep technical dives.
Research Projects¶
- Neo4j Memory System Research - Historical research (replaced with Kuzu)
- Executive Summary
- Technical Research
- Design Patterns
- Integration Guides
- External Knowledge
Advanced Topics¶
- Agent Type Memory Sharing Patterns - Advanced memory patterns
- Documentation Knowledge Graph - Graph-based doc navigation
- Workspace Pattern - Advanced workspace organization
π Reference & Resources¶
Quick references, guides, and additional resources.
Quick References¶
- Exception Handling Reference - Complete exception hierarchy and patterns
- Command Selection Guide - Choose the right command
- Platform Bridge API Reference - Complete API documentation
- Power Steering File Locking - Prevents counter race conditions
- UserPromptSubmit Hook API Reference - Framework injection API
- Doc Graph Quick Reference - Navigate documentation
- A/B Test Quick Reference - Test results
Developing amplihack¶
- Developing amplihack - Contribute to the framework
- Create Your Own Tools - Build custom tools
- Workflow to Skills Migration - Migration guide
Contributing¶
- File Organization - Where different file types belong in the repository
GitHub & Community¶
- GitHub Repository - Source code
- Issue Tracker - Report bugs or request features
- GitHub Pages - Online documentation
Philosophy in Action¶
amplihack follows three core principles:
-
Ruthless Simplicity: Start with the simplest solution that works. Add complexity only when justified.
-
Modular Design: Build self-contained modules (bricks) with clear public contracts (studs) that others can connect to.
-
Zero-BS Implementation: No stubs, no placeholders, no dead code. Every function must work or not exist.
Example Workflow¶
# Start with a feature request
/ultrathink "Add user authentication to the API"
# UltraThink will:
# 1. Read the default workflow
# 2. Orchestrate multiple agents (architect, security, api-designer, database, builder, tester)
# 3. Follow all workflow steps systematically
# 4. Ensure quality and philosophy compliance
# 5. Generate tests and documentation
Use Cases¶
amplihack excels at:
- Feature Development: Orchestrate multiple agents to design, implement, test, and document new features
- Code Review: Comprehensive analysis for philosophy compliance and best practices
- Refactoring: Systematic cleanup and improvement of existing code
- Investigation: Deep understanding of complex codebases and architectures
- Integration: Connect external services with proper error handling and testing
- Security: Vulnerability assessment and secure implementation patterns
Need Help?¶
- Start here: Prerequisites β Interactive Installation β Quick Start
- Common issues: Check Discoveries first
- Questions: See DDD FAQ
- Report issues: GitHub Issues
Ready to get started? Head to Prerequisites to set up amplihack in your development environment.