Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Erk Documentation

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.

Quick Start

New to erk? Start here:

  1. Prerequisites - Tools you need installed
  2. Installation - Install and configure erk
  3. Your First Plan - Complete tutorial from plan to PR

Documentation Sections

Step-by-step lessons to get you started.

Core concepts that explain how erk works.

Task-focused recipes for specific goals.

Complete technical reference.

Common questions and solutions.

Common User Journeys

"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

Other Documentation

Directory Audience Purpose
docs/learned/ AI agents Agent-generated patterns and conventions
docs/developer/ Contributors Internal development docs