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.tomlindex 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.tomlindex 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.mdindex 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`.## Hooksdiff --git a/skills/worktrunk/reference/config.md b/skills/worktrunk/reference/config.mdindex 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`.## Hooksdiff --git a/src/cli/mod.rs b/src/cli/mod.rsindex 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`.## Hooksdiff --git a/tests/snapshots/integration__integration_tests__help__help_config_create.snap b/tests/snapshots/integration__integration_tests__help__help_config_create.snapindex 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 [2m~/.config/worktrunk/config.toml[0m with the following content:[107m [0m [2m#[0m[107m [0m [2m# Controls where new worktrees are created.[0m[107m [0m [2m#[0m-[107m [0m [2m# **Variables:**[0m+[107m [0m [2m# **Available template variables:**[0m[107m [0m [2m#[0m[107m [0m [2m# - `{{ repo_path }}` — absolute path to the repository root (e.g., `/Users/me/code/myproject`. Or for bare repos, the bare directory itself)[0m[107m [0m [2m# - `{{ repo }}` — repository directory name (e.g., `myproject`)[0m@@ -307,7 +307,7 @@ Creates [2m~/.config/worktrunk/config.toml[0m with the following content:[107m [0m [2m#[0m[107m [0m [2m# pre-start = "npm ci"[0m[107m [0m [2m#[0m-[107m [0m [2m# Multiple named commands (concurrent for post-*, sequential for pre-*):[0m+[107m [0m [2m# Multiple named commands — concurrent for post-*, sequential for pre-*:[0m[107m [0m [2m#[0m[107m [0m [2m# [pre-merge][0m[107m [0m [2m# test = "npm test"[0m@@ -326,9 +326,9 @@ With [2m--project[0m, creates [2m.config/wt.toml[0m in the current repositor[107m [0m [2m# # Project Configuration[0m[107m [0m [2m#[0m-[107m [0m [2m# Create with `wt config create --project`. Examples shown — uncomment and customize for your project.[0m+[107m [0m [2m# 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.[0m[107m [0m [2m#[0m-[107m [0m [2m# Location: `.config/wt.toml` (checked into version control and shared with the team).[0m+[107m [0m [2m# To create a starter file with commented-out examples, run `wt config create --project`.[0m[107m [0m [2m#[0m[107m [0m [2m# ## Hooks[0m[107m [0m [2m#[0mdiff --git a/tests/snapshots/integration__integration_tests__help__help_config_long.snap b/tests/snapshots/integration__integration_tests__help__help_config_long.snapindex 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.-[1mVariables:[0m+[1mAvailable template variables:[0m- [2m{{ repo_path }}[0m — absolute path to the repository root (e.g., [2m/Users/me/code/myproject[0m. Or for bare repos, the bare directory itself)- [2m{{ repo }}[0m — repository directory name (e.g., [2mmyproject[0m)@@ -349,7 +349,7 @@ Single command:[107m [0m [2mpre-start = [0m[2m[32m"npm ci"[0m-Multiple named commands (concurrent for post-*, sequential for pre-*):+Multiple named commands — concurrent for post-*, sequential for pre-*:[107m [0m [2m[36m[pre-merge][0m[107m [0m [2mtest = [0m[2m[32m"npm test"[0m@@ -363,9 +363,9 @@ Pipeline — list of maps, run in order (each map concurrent):[107m [0m [2m][0m[32mPROJECT CONFIGURATION[0m-Create with [2mwt config create --project[0m. 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 [2m.config/wt.toml[0m and is typically checked into version control.-Location: [2m.config/wt.toml[0m (checked into version control and shared with the team).+To create a starter file with commented-out examples, run [2mwt config create --project[0m.[1m[32mHooks[0m