Skip to content

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

docs: clarify user project-specific settings section (#835)

Maximilian Roos3dd7657880fc
diff --git a/.claude-plugin/skills/worktrunk/reference/config.md b/.claude-plugin/skills/worktrunk/reference/config.md
index 55edda6fe..49c9a24f4 100644
--- a/.claude-plugin/skills/worktrunk/reference/config.md
+++ b/.claude-plugin/skills/worktrunk/reference/config.md
@@ -155,18 +155,24 @@ Pager behavior for `wt select` diff previews.
### User project-specific settings
-User config settings apply to all projects. [Project config](https://worktrunk.dev/config/#worktrunk-project-configuration) settings are shared with teammates. The `[projects]` table holds personal, project-specific settings like approved hook commands and worktree layout. Entries are keyed by project identifier (e.g., `github.com/user/repo`).
+For context:
+
+- [Project config](https://worktrunk.dev/config/#worktrunk-project-configuration) settings are shared with teammates.
+- User configs generally apply to all projects.
+- User configs _also_ has a `[projects]` table which holds project-specific settings for the user, such as approved hook commands and worktree layout. That's what this section covers.
+
+Entries are keyed by project identifier (e.g., `github.com/user/repo`).
#### Approved hook commands
-When a project hook runs for the first time, worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
+When a project hook runs for the first time, Worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
```toml
[projects."github.com/user/repo"]
approved-commands = ["npm ci", "npm test"]
```
-Auto-managed. To reset, delete the entry or run `wt hook approve --clear`.
+To reset, delete the entry or run `wt hook approvals clear`.
#### Setting overrides (Experimental)
diff --git a/dev/config.example.toml b/dev/config.example.toml
index 83d0c2bd2..ac6b30e6c 100644
--- a/dev/config.example.toml
+++ b/dev/config.example.toml
@@ -83,16 +83,22 @@
#
# ### User project-specific settings
#
-# User config settings apply to all projects. Project config (https://worktrunk.dev/config.md#worktrunk-project-configuration/) settings are shared with teammates. The `[projects]` table holds personal, project-specific settings like approved hook commands and worktree layout. Entries are keyed by project identifier (e.g., `github.com/user/repo`).
+# For context:
+#
+# - Project config (https://worktrunk.dev/config.md#worktrunk-project-configuration/) settings are shared with teammates.
+# - User configs generally apply to all projects.
+# - User configs _also_ has a `[projects]` table which holds project-specific settings for the user, such as approved hook commands and worktree layout. That's what this section covers.
+#
+# Entries are keyed by project identifier (e.g., `github.com/user/repo`).
#
# #### Approved hook commands
#
-# When a project hook runs for the first time, worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
+# When a project hook runs for the first time, Worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
#
# [projects."github.com/user/repo"]
# approved-commands = ["npm ci", "npm test"]
#
-# Auto-managed. To reset, delete the entry or run `wt hook approve --clear`.
+# To reset, delete the entry or run `wt hook approvals clear`.
#
# #### Setting overrides (Experimental)
#
diff --git a/docs/content/config.md b/docs/content/config.md
index 2fd08b5e7..d3422c562 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -163,18 +163,24 @@ Pager behavior for `wt select` diff previews.
### User project-specific settings
-User config settings apply to all projects. [Project config](@/config.md#worktrunk-project-configuration) settings are shared with teammates. The `[projects]` table holds personal, project-specific settings like approved hook commands and worktree layout. Entries are keyed by project identifier (e.g., `github.com/user/repo`).
+For context:
+
+- [Project config](@/config.md#worktrunk-project-configuration) settings are shared with teammates.
+- User configs generally apply to all projects.
+- User configs _also_ has a `[projects]` table which holds project-specific settings for the user, such as approved hook commands and worktree layout. That's what this section covers.
+
+Entries are keyed by project identifier (e.g., `github.com/user/repo`).
#### Approved hook commands
-When a project hook runs for the first time, worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
+When a project hook runs for the first time, Worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
```toml
[projects."github.com/user/repo"]
approved-commands = ["npm ci", "npm test"]
```
-Auto-managed. To reset, delete the entry or run `wt hook approve --clear`.
+To reset, delete the entry or run `wt hook approvals clear`.
#### Setting overrides (Experimental)
diff --git a/src/cli/mod.rs b/src/cli/mod.rs
index 8b531ff7c..48e6b9406 100644
--- a/src/cli/mod.rs
+++ b/src/cli/mod.rs
@@ -1619,18 +1619,24 @@ Pager behavior for `wt select` diff previews.
### User project-specific settings
-User config settings apply to all projects. [Project config](@/config.md#worktrunk-project-configuration) settings are shared with teammates. The `[projects]` table holds personal, project-specific settings like approved hook commands and worktree layout. Entries are keyed by project identifier (e.g., `github.com/user/repo`).
+For context:
+
+- [Project config](@/config.md#worktrunk-project-configuration) settings are shared with teammates.
+- User configs generally apply to all projects.
+- User configs _also_ has a `[projects]` table which holds project-specific settings for the user, such as approved hook commands and worktree layout. That's what this section covers.
+
+Entries are keyed by project identifier (e.g., `github.com/user/repo`).
#### Approved hook commands
-When a project hook runs for the first time, worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
+When a project hook runs for the first time, Worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
```toml
[projects."github.com/user/repo"]
approved-commands = ["npm ci", "npm test"]
```
-Auto-managed. To reset, delete the entry or run `wt hook approve --clear`.
+To reset, delete the entry or run `wt hook approvals clear`.
#### Setting overrides (Experimental)
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 830095ab0..8c76f0b4d 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_create.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_create.snap
@@ -135,16 +135,22 @@ Creates ~/.config/worktrunk/config.toml with the following content:
#
# ### User project-specific settings
#
- # User config settings apply to all projects. Project config (https://worktrunk.dev/config.md#worktrunk-project-configuration/) settings are shared with teammates. The `[projects]` table holds personal, project-specific settings like approved hook commands and worktree layout. Entries are keyed by project identifier (e.g., `github.com/user/repo`).
+ # For context:
+ #
+ # - Project config (https://worktrunk.dev/config.md#worktrunk-project-configuration/) settings are shared with teammates.
+ # - User configs generally apply to all projects.
+ # - User configs _also_ has a `[projects]` table which holds project-specific settings for the user, such as approved hook commands and worktree layout. That's what this section covers.
+ #
+ # Entries are keyed by project identifier (e.g., `github.com/user/repo`).
#
# #### Approved hook commands
#
- # When a project hook runs for the first time, worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
+ # When a project hook runs for the first time, Worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
#
# [projects."github.com/user/repo"]
# approved-commands = ["npm ci", "npm test"]
#
- # Auto-managed. To reset, delete the entry or run `wt hook approve --clear`.
+ # To reset, delete the entry or run `wt hook approvals clear`.
#
# #### Setting overrides (Experimental)
#
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 208d85ce2..f4860f8b0 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_long.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
@@ -180,16 +180,22 @@ Pager behavior for wt select diff previews.
User project-specific settings
-User config settings apply to all projects. Project config settings are shared with teammates. The [projects] table holds personal, project-specific settings like approved hook commands and worktree layout. Entries are keyed by project identifier (e.g., github.com/user/repo).
+For context:
+
+- Project config settings are shared with teammates.
+- User configs generally apply to all projects.
+- User configs _also_ has a [projects] table which holds project-specific settings for the user, such as approved hook commands and worktree layout. That's what this section covers.
+
+Entries are keyed by project identifier (e.g., github.com/user/repo).
Approved hook commands
-When a project hook runs for the first time, worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
+When a project hook runs for the first time, Worktrunk asks for approval. Approved commands are saved here, preventing repeated prompts.
[projects."github.com/user/repo"]
approved-commands = ["npm ci", "npm test"]
-Auto-managed. To reset, delete the entry or run wt hook approve --clear.
+To reset, delete the entry or run wt hook approvals clear.
Setting overrides (Experimental)