Skip to content

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

docs(config): improve project config intro and template variable heading (#2032)

Worktrunk Botb6ddf736d79c
diff --git a/dev/config.example.toml b/dev/config.example.toml
index f61690168..250264a02 100644
--- a/dev/config.example.toml
+++ b/dev/config.example.toml
@@ -11,7 +11,7 @@
#
# Controls where new worktrees are created.
#
-# **Variables:**
+# **Available template variables:**
#
# - `{{ repo_path }}` — absolute path to the repository root (e.g., `/Users/me/code/myproject`. Or for bare repos, the bare directory itself)
# - `{{ repo }}` — repository directory name (e.g., `myproject`)
@@ -247,7 +247,7 @@
#
# pre-start = "npm ci"
#
-# Multiple named commands (concurrent for post-*, sequential for pre-*):
+# Multiple named commands — concurrent for post-*, sequential for pre-*:
#
# [pre-merge]
# test = "npm test"
diff --git a/dev/wt.example.toml b/dev/wt.example.toml
index 48f1e3e99..8f871281f 100644
--- a/dev/wt.example.toml
+++ b/dev/wt.example.toml
@@ -1,8 +1,8 @@
# # Project Configuration
#
-# Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
+# Project configuration lets teams share repository-specific settings — hooks, dev server URLs, and other defaults. The file lives in `.config/wt.toml` and is typically checked into version control.
#
-# Location: `.config/wt.toml` (checked into version control and shared with the team).
+# To create a starter file with commented-out examples, run `wt config create --project`.
#
# ## Hooks
#
diff --git a/docs/content/config.md b/docs/content/config.md
index 32490a6d1..45e477895 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -73,7 +73,7 @@ Location:
Controls where new worktrees are created.
-**Variables:**
+**Available template variables:**
- `{{ repo_path }}` — absolute path to the repository root (e.g., `/Users/me/code/myproject`. Or for bare repos, the bare directory itself)
- `{{ repo }}` — repository directory name (e.g., `myproject`)
@@ -347,7 +347,7 @@ Single command:
pre-start = "npm ci"
```
-Multiple named commands (concurrent for post-*, sequential for pre-*):
+Multiple named commands — concurrent for post-*, sequential for pre-*:
```toml
[pre-merge]
@@ -367,9 +367,9 @@ post-start = [
<!-- PROJECT_CONFIG_START -->
# Project Configuration
-Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
+Project configuration lets teams share repository-specific settings — hooks, dev server URLs, and other defaults. The file lives in `.config/wt.toml` and is typically checked into version control.
-Location: `.config/wt.toml` (checked into version control and shared with the team).
+To create a starter file with commented-out examples, run `wt config create --project`.
## Hooks
diff --git a/skills/worktrunk/reference/config.md b/skills/worktrunk/reference/config.md
index 293d2a45b..3d1f4d980 100644
--- a/skills/worktrunk/reference/config.md
+++ b/skills/worktrunk/reference/config.md
@@ -72,7 +72,7 @@ Location:
Controls where new worktrees are created.
-**Variables:**
+**Available template variables:**
- `{{ repo_path }}` — absolute path to the repository root (e.g., `/Users/me/code/myproject`. Or for bare repos, the bare directory itself)
- `{{ repo }}` — repository directory name (e.g., `myproject`)
@@ -346,7 +346,7 @@ Single command:
pre-start = "npm ci"
```
-Multiple named commands (concurrent for post-*, sequential for pre-*):
+Multiple named commands — concurrent for post-*, sequential for pre-*:
```toml
[pre-merge]
@@ -366,9 +366,9 @@ post-start = [
<!-- PROJECT_CONFIG_START -->
# Project Configuration
-Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
+Project configuration lets teams share repository-specific settings — hooks, dev server URLs, and other defaults. The file lives in `.config/wt.toml` and is typically checked into version control.
-Location: `.config/wt.toml` (checked into version control and shared with the team).
+To create a starter file with commented-out examples, run `wt config create --project`.
## Hooks
diff --git a/src/cli/mod.rs b/src/cli/mod.rs
index 6e21adb4f..fd1cbc4cc 100644
--- a/src/cli/mod.rs
+++ b/src/cli/mod.rs
@@ -1698,7 +1698,7 @@ Location:
Controls where new worktrees are created.
-**Variables:**
+**Available template variables:**
- `{{ repo_path }}` — absolute path to the repository root (e.g., `/Users/me/code/myproject`. Or for bare repos, the bare directory itself)
- `{{ repo }}` — repository directory name (e.g., `myproject`)
@@ -1972,7 +1972,7 @@ Single command:
pre-start = "npm ci"
```
-Multiple named commands (concurrent for post-*, sequential for pre-*):
+Multiple named commands — concurrent for post-*, sequential for pre-*:
```toml
[pre-merge]
@@ -1992,9 +1992,9 @@ post-start = [
<!-- PROJECT_CONFIG_START -->
# Project Configuration
-Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
+Project configuration lets teams share repository-specific settings — hooks, dev server URLs, and other defaults. The file lives in `.config/wt.toml` and is typically checked into version control.
-Location: `.config/wt.toml` (checked into version control and shared with the team).
+To create a starter file with commented-out examples, run `wt config create --project`.
## Hooks
diff --git a/tests/snapshots/integration__integration_tests__help__help_config_create.snap b/tests/snapshots/integration__integration_tests__help__help_config_create.snap
index 080399b74..cffd7f2c2 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_create.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_create.snap
@@ -71,7 +71,7 @@ Creates ~/.config/worktrunk/config.toml with the following content:
  #
  # Controls where new worktrees are created.
  #
-  # **Variables:**
+  # **Available template variables:**
  #
  # - `{{ repo_path }}` — absolute path to the repository root (e.g., `/Users/me/code/myproject`. Or for bare repos, the bare directory itself)
  # - `{{ repo }}` — repository directory name (e.g., `myproject`)
@@ -307,7 +307,7 @@ Creates ~/.config/worktrunk/config.toml with the following content:
  #
  # pre-start = "npm ci"
  #
-  # Multiple named commands (concurrent for post-*, sequential for pre-*):
+  # Multiple named commands — concurrent for post-*, sequential for pre-*:
  #
  # [pre-merge]
  # test = "npm test"
@@ -326,9 +326,9 @@ With --project, creates .config/wt.toml in the current repositor
  # # Project Configuration
  #
-  # Create with `wt config create --project`. Examples shown — uncomment and customize for your project.
+  # Project configuration lets teams share repository-specific settings — hooks, dev server URLs, and other defaults. The file lives in `.config/wt.toml` and is typically checked into version control.
  #
-  # Location: `.config/wt.toml` (checked into version control and shared with the team).
+  # To create a starter file with commented-out examples, run `wt config create --project`.
  #
  # ## Hooks
  #
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 ca747d898..282a77e2f 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_long.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
@@ -117,7 +117,7 @@ Location:
Controls where new worktrees are created.
-Variables:
+Available template variables:
- {{ repo_path }} — absolute path to the repository root (e.g., /Users/me/code/myproject. Or for bare repos, the bare directory itself)
- {{ repo }} — repository directory name (e.g., myproject)
@@ -349,7 +349,7 @@ Single command:
  pre-start = "npm ci"
-Multiple named commands (concurrent for post-*, sequential for pre-*):
+Multiple named commands — concurrent for post-*, sequential for pre-*:
  [pre-merge]
  test = "npm test"
@@ -363,9 +363,9 @@ Pipeline — list of maps, run in order (each map concurrent):
  ]
PROJECT CONFIGURATION
-Create with wt config create --project. Examples shown — uncomment and customize for your project.
+Project configuration lets teams share repository-specific settings — hooks, dev server URLs, and other defaults. The file lives in .config/wt.toml and is typically checked into version control.
-Location: .config/wt.toml (checked into version control and shared with the team).
+To create a starter file with commented-out examples, run wt config create --project.
Hooks