erk is a CLI tool for plan-oriented agentic engineering—a workflow where AI agents create implementation plans, execute them in isolated worktrees, and ship code via automated PR workflows.
For the philosophy and design principles behind erk, see The TAO of erk.
New to erk? Start here:
- Prerequisites - Tools you need installed
- Installation - Install and configure erk
- Your First Plan - Complete tutorial from plan to PR
Step-by-step lessons to get you started.
- Prerequisites - Required tools and versions
- Installation - Installing and initializing erk
- Your First Plan - End-to-end tutorial
- Shell Integration - Terminal setup for directory switching
Core concepts that explain how erk works.
- Worktrees - Parallel development with git worktrees
- Stacked PRs - Building changes incrementally with Graphite
- Plan Mode - Claude Code's planning workflow
- The Workflow - From idea to merged PR
- Plan-Oriented Engineering - The philosophy behind erk
Task-focused recipes for specific goals.
- Use the Local Workflow - Plan, implement, and ship locally
- Run Remote Execution - Run implementations in GitHub Actions
- Checkout and Sync PRs - Review and iterate on PRs
- Resolve Merge Conflicts - Handle merge conflicts with AI assistance
- Work Without Plans - Quick changes without formal plans
- Extract Documentation - Capture patterns for future agents
Complete technical reference.
- CLI Command Reference - All CLI commands
- Slash Command Reference - Claude Code slash commands
- Configuration Reference - Config files and options
- File Location Reference - Where erk stores data
Common questions and solutions.
- Shell Integration - Directory switching problems
- Graphite Issues - Stack and sync problems
- General - Frequently asked questions
"I want to start using erk" → Prerequisites → Installation → Your First Plan
"I want to understand how erk works" → The Workflow → Plan-Oriented Engineering
"I'm reviewing a teammate's PR" → Checkout and Sync PRs
"My rebase has conflicts" → Resolve Merge Conflicts
"I need quick iteration without planning" → Work Without Plans
| Directory | Audience | Purpose |
|---|---|---|
| docs/learned/ | AI agents | Agent-generated patterns and conventions |
| docs/developer/ | Contributors | Internal development docs |