Skip to content

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

Refactor documentation content and formatting

Maximilian Roos3af38cb679f3
diff --git a/README.md b/README.md
index a450139d5..dfe5037aa 100644
--- a/README.md
+++ b/README.md
@@ -22,19 +22,19 @@ Here's a quick demo:
> ## πŸ“š Full documentation at [worktrunk.dev](https://worktrunk.dev) πŸ“š
-<!-- ⚠️ AUTO-GENERATED from docs/content/worktrunk.md#context-git-worktrees..worktrunk-makes-git-worktrees-easy β€” edit source to update -->
+<!-- ⚠️ AUTO-GENERATED from docs/content/worktrunk.md#context-git-worktrees..worktrunk-makes-git-worktrees-simple β€” edit source to update -->
## Context: git worktrees
-AI agents like Claude Code and Codex can handle longer tasks without supervision,
-and running several in parallel is practical. Git worktrees give each agent its
-own working directory β€” no stepping on each other's changes.
+AI agents like Claude Code and Codex can handle longer tasks without
+supervision, such that it's possible to manage 5-10+ in parallel. Git worktrees
+give each agent its own working directory; no stepping on each other's changes.
-But the git worktree UX is clunky. Even starting a new worktree means typing the
-branch name three times: `git worktree add -b feature ../repo.feature`, then
-`cd ../repo.feature`.
+But the git worktree UX is clunky. Even a task as simple as starting a new
+worktree requires typing the branch name three times: `git worktree add -b feature
+../repo.feature`, then `cd ../repo.feature`.
-## Worktrunk makes git worktrees easy
+## Worktrunk makes git worktrees simple
Start with the core commands; add workflow automation as needed.
@@ -81,7 +81,7 @@ git branch -d feature</pre></td>
- **[Lifecycle hooks](https://worktrunk.dev/hook/)** β€” run commands on create, pre-merge, post-merge
- **[LLM commit messages](https://worktrunk.dev/llm-commits/)** β€” generate commit messages from diffs via [llm](https://llm.datasette.io/)
- **[Merge workflow](https://worktrunk.dev/merge/)** β€” squash, rebase, merge, clean up in one command
-- ...and [lots more](#next-steps)
+- ...and **[lots more](#next-steps)**
<!-- END AUTO-GENERATED -->
@@ -107,7 +107,9 @@ $ wt config shell install
- Learn the core commands: [wt switch](https://worktrunk.dev/switch/), [wt list](https://worktrunk.dev/list/), [wt merge](https://worktrunk.dev/merge/), [wt remove](https://worktrunk.dev/remove/)
- Set up [project hooks](https://worktrunk.dev/hook/) for automated setup
-- Explore [LLM commit messages](https://worktrunk.dev/llm-commits/), [fzf-like picker](https://worktrunk.dev/select/), [Claude Code integration](https://worktrunk.dev/claude-code/), [CI status & PR links](https://worktrunk.dev/list/#ci-status)
+- Explore [LLM commit messages](https://worktrunk.dev/llm-commits/), [fzf-like
+ selector](https://worktrunk.dev/select/), [Claude Code integration](https://worktrunk.dev/claude-code/), [CI
+ status & PR links](https://worktrunk.dev/list/#ci-status)
- Run `wt --help` or `wt <command> --help` for quick CLI reference
## Further reading
diff --git a/docs/content/worktrunk.md b/docs/content/worktrunk.md
index bb61cc9cc..f5cdcadc4 100644
--- a/docs/content/worktrunk.md
+++ b/docs/content/worktrunk.md
@@ -17,15 +17,15 @@ Here's a quick demo:
## Context: git worktrees
-AI agents like Claude Code and Codex can handle longer tasks without supervision,
-and running several in parallel is practical. Git worktrees give each agent its
-own working directory β€” no stepping on each other's changes.
+AI agents like Claude Code and Codex can handle longer tasks without
+supervision, such that it's possible to manage 5-10+ in parallel. Git worktrees
+give each agent its own working directory; no stepping on each other's changes.
-But the git worktree UX is clunky. Even starting a new worktree means typing the
-branch name three times: `git worktree add -b feature ../repo.feature`, then
-`cd ../repo.feature`.
+But the git worktree UX is clunky. Even a task as simple as starting a new
+worktree requires typing the branch name three times: `git worktree add -b feature
+../repo.feature`, then `cd ../repo.feature`.
-## Worktrunk makes git worktrees easy
+## Worktrunk makes git worktrees simple
Start with the core commands; add workflow automation as needed.
@@ -72,7 +72,7 @@ git branch -d feature{% end %}</td>
- **[Lifecycle hooks](@/hook.md)** β€” run commands on create, pre-merge, post-merge
- **[LLM commit messages](@/llm-commits.md)** β€” generate commit messages from diffs via [llm](https://llm.datasette.io/)
- **[Merge workflow](@/merge.md)** β€” squash, rebase, merge, clean up in one command
-- ...and [lots more](#next-steps)
+- ...and **[lots more](#next-steps)**
## Install
@@ -94,7 +94,9 @@ $ wt config shell install
- Learn the core commands: [wt switch](@/switch.md), [wt list](@/list.md), [wt merge](@/merge.md), [wt remove](@/remove.md)
- Set up [project hooks](@/hook.md) for automated setup
-- Explore [LLM commit messages](@/llm-commits.md), [fzf-like picker](@/select.md), [Claude Code integration](@/claude-code.md), [CI status & PR links](@/list.md#ci-status)
+- Explore [LLM commit messages](@/llm-commits.md), [fzf-like
+ selector](@/select.md), [Claude Code integration](@/claude-code.md), [CI
+ status & PR links](@/list.md#ci-status)
- Run `wt --help` or `wt <command> --help` for quick CLI reference
## Further reading