Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

Docs: Update README with `wt` command examples

Maximilian Roos789d59f36cee
diff --git a/README.md b/README.md
index c2ed17bf6..761629b2a 100644
--- a/README.md
+++ b/README.md
@@ -30,10 +30,6 @@ So we use git worktrees: many working directories, one repository.
## Why Worktrunk?
-Raw `git worktree` means inventing directory names, tracking paths, and remembering cleanup steps.
-
-Worktrunk maintains a 1:1 mapping: branches get predictable paths (`../repo.<branch>/`), hooks run at creation and merge, and `wt merge` handles cleanup.
-
Three commands:
| Command | What it does |
@@ -42,6 +38,31 @@ Three commands:
| `wt merge` | Squash, rebase, run hooks, merge, clean up |
| `wt list` | Show status across all worktrees and branches |
+```bash
+# Create worktree and start Claude
+wt: wt switch --create feature -x claude
+git: git worktree add -b feature ../repo.feature main && cd ../repo.feature && claude
+```
+
+```bash
+# Merge and clean up
+wt: wt merge
+git: cd ../repo && git merge feature && git worktree remove ../repo.feature && git branch -d feature
+```
+
+```bash
+# Full merge workflow
+wt: wt merge # with hooks configured
+git: git add -A
+ git reset --soft $(git merge-base HEAD main) # squash
+ git diff --staged | llm "write a commit message" | git commit -F - # [commit-generation]
+ git rebase main
+ cargo test # [pre-merge] hook
+ cd ../repo && git merge --ff-only feature
+ git worktree remove ../repo.feature && git branch -d feature
+ cargo install --path . # [post-merge] hook
+```
+
## Quick Start
### 1. Install