Skip to content

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

Clarify config documentation for command flags

Maximilian Rooscc3f201792db
diff --git a/docs/content/config.md b/docs/content/config.md
index 2fc892550..f6e80d106 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -65,17 +65,18 @@ worktree-path = ".worktrees/{{ branch }}"
worktree-path = "../worktrees/{{ main_worktree }}/{{ branch }}"
```
-### Command defaults
+### Command settings
-Override default flag behavior for commands. Settings here apply unless explicitly overridden on the command line.
+Set persistent flag values for commands. These apply unless explicitly overridden on the command line.
-**`wt list` defaults:**
+**`wt list`:**
```toml
[list]
-full = true # --full (default: false)
-branches = true # --branches (default: false)
-remotes = true # --remotes (default: false)
+# All off by default
+full = true # --full
+branches = true # --branches
+remotes = true # --remotes
```
**`wt step commit` and `wt merge` staging:**
@@ -85,15 +86,15 @@ remotes = true # --remotes (default: false)
stage = "all" # "all" (default), "tracked", or "none"
```
-**`wt merge` defaults:**
+**`wt merge`:**
```toml
[merge]
-# All options default to true
-squash = false # --no-squash: preserve individual commits
-commit = false # --no-commit: skip committing uncommitted changes
-remove = false # --no-remove: keep worktree after merge
-verify = false # --no-verify: skip project hooks
+# These flags are on by default; set to false to disable
+squash = false # Preserve individual commits (--no-squash)
+commit = false # Skip committing uncommitted changes (--no-commit)
+remove = false # Keep worktree after merge (--no-remove)
+verify = false # Skip project hooks (--no-verify)
```
### LLM commit messages
diff --git a/src/cli.rs b/src/cli.rs
index 0a9ebbc35..619cf3e19 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -720,17 +720,18 @@ worktree-path = ".worktrees/{{ branch }}"
worktree-path = "../worktrees/{{ main_worktree }}/{{ branch }}"
```
-### Command defaults
+### Command settings
-Override default flag behavior for commands. Settings here apply unless explicitly overridden on the command line.
+Set persistent flag values for commands. These apply unless explicitly overridden on the command line.
-**`wt list` defaults:**
+**`wt list`:**
```toml
[list]
-full = true # --full (default: false)
-branches = true # --branches (default: false)
-remotes = true # --remotes (default: false)
+# All off by default
+full = true # --full
+branches = true # --branches
+remotes = true # --remotes
```
**`wt step commit` and `wt merge` staging:**
@@ -740,15 +741,15 @@ remotes = true # --remotes (default: false)
stage = "all" # "all" (default), "tracked", or "none"
```
-**`wt merge` defaults:**
+**`wt merge`:**
```toml
[merge]
-# All options default to true
-squash = false # --no-squash: preserve individual commits
-commit = false # --no-commit: skip committing uncommitted changes
-remove = false # --no-remove: keep worktree after merge
-verify = false # --no-verify: skip project hooks
+# These flags are on by default; set to false to disable
+squash = false # Preserve individual commits (--no-squash)
+commit = false # Skip committing uncommitted changes (--no-commit)
+remove = false # Keep worktree after merge (--no-remove)
+verify = false # Skip project hooks (--no-verify)
```
### LLM commit messages
diff --git a/tests/snapshots/integration__integration_tests__help__help_config_long.snap b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
index 99990edf6..6b8fdd715 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_long.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
@@ -91,30 +91,31 @@ Controls where new worktrees are created. The template is relative to the reposi
# Creates: ~/code/worktrees/myproject/feature-login
worktree-path = "../worktrees/{{ main_worktree }}/{{ branch }}"
-Command defaults
+Command settings
-Override default flag behavior for commands. Settings here apply unless explicitly overridden on the command line.
+Set persistent flag values for commands. These apply unless explicitly overridden on the command line.
-`wt list` defaults:
+`wt list`:
[list]
- full = true # --full (default: false)
- branches = true # --branches (default: false)
- remotes = true # --remotes (default: false)
+ # All off by default
+ full = true # --full
+ branches = true # --branches
+ remotes = true # --remotes
`wt step commit` and `wt merge` staging:
[commit]
stage = "all" # "all" (default), "tracked", or "none"
-`wt merge` defaults:
+`wt merge`:
[merge]
- # All options default to true
- squash = false # --no-squash: preserve individual commits
- commit = false # --no-commit: skip committing uncommitted changes
- remove = false # --no-remove: keep worktree after merge
- verify = false # --no-verify: skip project hooks
+ # These flags are on by default; set to false to disable
+ squash = false # Preserve individual commits (--no-squash)
+ commit = false # Skip committing uncommitted changes (--no-commit)
+ remove = false # Keep worktree after merge (--no-remove)
+ verify = false # Skip project hooks (--no-verify)
LLM commit messages