Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows
docs: Sync plugin README with main README
Maximilian Roosd11bd107fa4c
diff --git a/.claude-plugin/skills/worktrunk/reference/README.md b/.claude-plugin/skills/worktrunk/reference/README.mdindex 00b483d2a..42e2ff397 100644--- a/.claude-plugin/skills/worktrunk/reference/README.md+++ b/.claude-plugin/skills/worktrunk/reference/README.md@@ -547,6 +547,9 @@ Options:--branchesInclude branches without worktrees+ --remotes+ Include remote branches from primary remote+-v, --verboseShow git commands and debug info@@ -661,7 +664,7 @@ jq '.[] | select(.locked != null)'Usage: wt config [OPTIONS] <COMMAND>Commands:- init Initialize global configuration file with examples+ create Create global configuration filelist List configuration files & locationsrefresh-cache Refresh default branch from remoteshell Configure shell integration@@ -696,7 +699,7 @@ Enable AI-generated commit messagesllm install llm-anthropicllm keys set anthropic# Paste your API key from: https://console.anthropic.com/settings/keys- llm models default claude-3.5-sonnet+ llm models default claude-sonnet-4-5```For OpenAI:@@ -735,6 +738,7 @@ These commands are subject to change:- `wt beta push [target]` - Push changes to target branch (auto-stashes non-conflicting edits)- `wt beta rebase [target]` - Rebase current branch onto target- `wt beta ask-approvals` - Approve commands in project config+- `wt beta clear-approvals` - Clear approved commands from config- `wt beta run-hook <hook-type>` - Run a project hook for testing- `wt beta select` - Interactive worktree selector (Unix only, WIP)@@ -754,6 +758,7 @@ wt config --help # Show LLM setup guide**Global config** (`~/.config/worktrunk/config.toml`):- `worktree-path` - Path template for new worktrees+- `[list]` - Default display options for `wt list` (full, branches, remotes)- `[commit-generation]` - LLM command and prompt templates- `[projects."project-id"]` - Per-project approved commands (auto-populated)@@ -783,7 +788,7 @@ approved-commands = ["npm install", "npm test"]**Example project config** (`.config/wt.toml`): See Project Hooks section above.-**Path template defaults:** `../repo.branch/` (siblings to main repo). Available variables: `{{ main_worktree }}`, `{{ branch }}`, `{{ repo }}`.+**Path template defaults:** `../{{ main_worktree }}.{{ branch }}` (siblings to main repo). Available variables: `{{ main_worktree }}`, `{{ branch }}`, `{{ repo }}`.</details>diff --git a/.claude-plugin/skills/worktrunk/reference/hook-types-reference.md b/.claude-plugin/skills/worktrunk/reference/hook-types-reference.mdindex 5d449fef4..0802d6fa7 100644--- a/.claude-plugin/skills/worktrunk/reference/hook-types-reference.md+++ b/.claude-plugin/skills/worktrunk/reference/hook-types-reference.md@@ -46,7 +46,7 @@ post-create-command = [### post-start-command-**When it runs**: After switching to an existing worktree (not on creation).+**When it runs**: After creating a new worktree (not when switching to existing).**Behavior**:- Runs in background, doesn't block user@@ -69,7 +69,7 @@ post-start-command = []```-**What happens**: User runs `wt switch feature-x`. All three commands start immediately in parallel. User can work while they run. Check `.wt-logs/` for output.+**What happens**: User runs `wt switch --create feature-x`. After creation completes, all three commands start immediately in parallel in background. User can work while they run. Check `.wt-logs/` for output.### pre-commit-commanddiff --git a/CLAUDE.md b/CLAUDE.mdindex fe8ba8846..728230fa5 100644--- a/CLAUDE.md+++ b/CLAUDE.md@@ -540,7 +540,7 @@ Use `wt list --format=json` for structured data access. The output is an array o### Branch-Specific Fields-- `name`: branch name+Branches use the same `branch` field as worktrees (no additional fields).### JSON Field Documentationdiff --git a/README.md b/README.mdindex 00b483d2a..42e2ff397 100644--- a/README.md+++ b/README.md@@ -547,6 +547,9 @@ Options:--branchesInclude branches without worktrees+ --remotes+ Include remote branches from primary remote+-v, --verboseShow git commands and debug info@@ -661,7 +664,7 @@ jq '.[] | select(.locked != null)'Usage: wt config [OPTIONS] <COMMAND>Commands:- init Initialize global configuration file with examples+ create Create global configuration filelist List configuration files & locationsrefresh-cache Refresh default branch from remoteshell Configure shell integration@@ -696,7 +699,7 @@ Enable AI-generated commit messagesllm install llm-anthropicllm keys set anthropic# Paste your API key from: https://console.anthropic.com/settings/keys- llm models default claude-3.5-sonnet+ llm models default claude-sonnet-4-5```For OpenAI:@@ -735,6 +738,7 @@ These commands are subject to change:- `wt beta push [target]` - Push changes to target branch (auto-stashes non-conflicting edits)- `wt beta rebase [target]` - Rebase current branch onto target- `wt beta ask-approvals` - Approve commands in project config+- `wt beta clear-approvals` - Clear approved commands from config- `wt beta run-hook <hook-type>` - Run a project hook for testing- `wt beta select` - Interactive worktree selector (Unix only, WIP)@@ -754,6 +758,7 @@ wt config --help # Show LLM setup guide**Global config** (`~/.config/worktrunk/config.toml`):- `worktree-path` - Path template for new worktrees+- `[list]` - Default display options for `wt list` (full, branches, remotes)- `[commit-generation]` - LLM command and prompt templates- `[projects."project-id"]` - Per-project approved commands (auto-populated)@@ -783,7 +788,7 @@ approved-commands = ["npm install", "npm test"]**Example project config** (`.config/wt.toml`): See Project Hooks section above.-**Path template defaults:** `../repo.branch/` (siblings to main repo). Available variables: `{{ main_worktree }}`, `{{ branch }}`, `{{ repo }}`.+**Path template defaults:** `../{{ main_worktree }}.{{ branch }}` (siblings to main repo). Available variables: `{{ main_worktree }}`, `{{ branch }}`, `{{ repo }}`.</details>