Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.51 KB

File metadata and controls

56 lines (38 loc) · 1.51 KB

erk

erk is a CLI tool for plan-oriented agentic engineering: create implementation plans with AI, save them to GitHub, 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.

Quick Start

# Install prerequisites: python 3.10+, claude, uv, gt, gh

# Install erk in your project
uv add erk && uv sync

# Initialize in your repo
erk init

# Verify setup
erk doctor

Then follow Your First Plan to learn the workflow.

The Workflow

The primary workflow: plan → save → implement → ship. Often completes without touching an IDE.

# 1. Plan (in Claude Code)
claude
# → develop plan → save to GitHub issue #42

# 2. Implement
erk implement 42

# 3. Submit PR
erk pr submit

# 4. Address feedback
/erk:pr-address

# 5. Land
erk land

See The Workflow for the complete guide.

Documentation

Section Description
Tutorials Setup, installation, first plan tutorial
Topics Worktrees, stacked PRs, plan mode
How-to Guides Workflows for common tasks
Reference Commands, configuration, file locations
FAQ Common questions and troubleshooting