This repository is intended to be supplemental to the Amp Manual.
Guides are intended to provide high-level guidance on using Amp with various development workflows and patterns. They shouldn't focus specifically on any given language or framework and should apply to workflows regardless of tools, languages, or frameworks in use.
| Guide | Description |
|---|---|
| Agent File | Using AGENT.md files to provide Amp with codebase structure, build/test commands, and conventions |
| Command Piping | Using the output of other commands to provide input to an Amp prompt |
| Context Management | High-level guidance on context engineering for agentic AI workflows |
| Code Migrations | Methodologies for migrations and upgrades using AI-guided planning |
| Documentation Workflows | Strategic approaches to documentation generation and maintenance |
| MCP Setup | General workflow guidance for Model Context Protocol integration |
| Day 0 Operations | Initial project setup and onboarding workflows |
| CLI Guide | Complete guide to using Amp from the command line |
| Tips & Tricks | Community-contributed tips and power-user insights |
The following guides are organized by software development lifecycle phases to help you leverage Amp effectively throughout your development process:
Planning Guide - Analyse, explore, and strategize your development approach with intelligent codebase understanding
- Codebase Exploration & Understanding
- Search & Contextual Analysis Across Codebase
- Git History Exploration & Feature Evolution
- Learning and Discovery
- Feature Implementation Planning
Building Guide - Implement, refactor, and enhance your code with AI-assisted development and testing
- Code Analysis and Refactoring
- UI Iteration with Visual Feedback
- MCP Integration
- IDE Completions and Context-Aware Development
- Automated Refactoring & Standards Enforcement
- End-to-End Test Generation
- Automate Debugging Loops
- From Bug Report to Draft PR
Deployment Guide - Streamline your deployment pipeline with automated workflows and quality gates
- Git Workflow Enhancement
- Build and Test Automation
- Automated Pull Request Generation
- End-to-End Development Workflows
- Database Operations
Support Guide - Maintain, secure, and collaborate on your deployed applications with ongoing optimisation
- Documentation Generation
- Security and Code Quality
- Batch File Operations
- Development Environment Debugging
- Review & Cleanup Changes
- Thread History & Contextual Documentation
- Team Knowledge Sharing & Collaboration
- Cross-Platform Thread Sharing
Examples are intended to address specific use-cases with languages, frameworks, or tools. Examples should be concise, focused, and should always contain a Thread link to provide additional context on how Amp solved an example use-case.
| Example | Description |
|---|---|
| Amp + Code Search | Utilizing Sourcegraph code search to make targeted changes across multiple repositories |
| Multi-root Workspaces | Working with multiple projects in a single workspace |
| OpenAPI Spec Generation | Generating and maintaining OpenAPI specifications |
| GitHub Review Bot | Automated code review bot using GitHub Actions and Amp CLI |
| GitLab Review Bot | Automated merge request reviews with GitLab CI and Amp |
| JetBrains IDE Setup | Setting up Amp with JetBrains IDEs for enhanced context |
| SonarQube Automation | Automated SonarQube issue processing and PR creation |
Below is a general example of how content should be organized within the repository.
.
├── examples
│ └── amp+codesearch
│ └── README.md
├── guides
│ └── command-piping
│ └── README.md
└── README.md