Skip to content

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

docs(config): trim project config section, link to hook.md (#855)

Maximilian Rooscbce1ab7757f
diff --git a/.claude-plugin/skills/worktrunk/reference/config.md b/.claude-plugin/skills/worktrunk/reference/config.md
index 0f63c0dc4..8c9b0e091 100644
--- a/.claude-plugin/skills/worktrunk/reference/config.md
+++ b/.claude-plugin/skills/worktrunk/reference/config.md
@@ -280,45 +280,26 @@ Combine these commits into a single commit message.
---
-## Worktrunk Project Configuration
+## Project configuration
-The project config defines lifecycle hooks and project-specific settings. This file is checked into version control and shared across the team.
+Project config (`.config/wt.toml`) defines lifecycle hooks and project-specific settings. This file is checked into version control and shared with the team. Create with `wt config create --project`.
-Create `.config/wt.toml` in the repository root:
+See [`wt hook`](https://worktrunk.dev/hook/) for hook types, execution order, template variables, and examples.
-```toml
-[post-create]
-install = "npm ci"
-
-[pre-merge]
-test = "npm test"
-lint = "npm run lint"
-```
-
-See [`wt hook`](https://worktrunk.dev/hook/) for complete documentation on hook types, execution order, template variables, and [JSON context](https://worktrunk.dev/hook/#json-context).
-
-### Dev server URL
-
-The `[list]` section adds a URL column to `wt list`:
+### Non-hook settings
```toml
+# .config/wt.toml
+
+# URL column in wt list (dimmed when port not listening)
[list]
url = "http://localhost:{{ branch | hash_port }}"
-```
-
-URLs are dimmed when the port isn't listening.
-### CI platform override
-
-The `[ci]` section overrides CI platform detection for GitHub Enterprise or self-hosted GitLab with custom domains:
-
-```toml
+# Override CI platform detection for self-hosted instances
[ci]
platform = "github" # or "gitlab"
```
-By default, the platform is detected from the remote URL. Use this when URL detection fails (e.g., `git.mycompany.com` instead of `github.mycompany.com`).
-
---
## Shell integration
diff --git a/docs/content/config.md b/docs/content/config.md
index 2959942dd..d6f2acef1 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -288,45 +288,26 @@ Combine these commits into a single commit message.
---
-## Worktrunk Project Configuration
+## Project configuration
-The project config defines lifecycle hooks and project-specific settings. This file is checked into version control and shared across the team.
+Project config (`.config/wt.toml`) defines lifecycle hooks and project-specific settings. This file is checked into version control and shared with the team. Create with `wt config create --project`.
-Create `.config/wt.toml` in the repository root:
+See [`wt hook`](@/hook.md) for hook types, execution order, template variables, and examples.
-```toml
-[post-create]
-install = "npm ci"
-
-[pre-merge]
-test = "npm test"
-lint = "npm run lint"
-```
-
-See [`wt hook`](@/hook.md) for complete documentation on hook types, execution order, template variables, and [JSON context](@/hook.md#json-context).
-
-### Dev server URL
-
-The `[list]` section adds a URL column to `wt list`:
+### Non-hook settings
```toml
+# .config/wt.toml
+
+# URL column in wt list (dimmed when port not listening)
[list]
url = "http://localhost:{{ branch | hash_port }}"
-```
-
-URLs are dimmed when the port isn't listening.
-### CI platform override
-
-The `[ci]` section overrides CI platform detection for GitHub Enterprise or self-hosted GitLab with custom domains:
-
-```toml
+# Override CI platform detection for self-hosted instances
[ci]
platform = "github" # or "gitlab"
```
-By default, the platform is detected from the remote URL. Use this when URL detection fails (e.g., `git.mycompany.com` instead of `github.mycompany.com`).
-
---
## Shell integration
diff --git a/src/cli/mod.rs b/src/cli/mod.rs
index 44ae4739d..a156206e3 100644
--- a/src/cli/mod.rs
+++ b/src/cli/mod.rs
@@ -1728,45 +1728,26 @@ Combine these commits into a single commit message.
---
-## Worktrunk Project Configuration
+## Project configuration
-The project config defines lifecycle hooks and project-specific settings. This file is checked into version control and shared across the team.
+Project config (`.config/wt.toml`) defines lifecycle hooks and project-specific settings. This file is checked into version control and shared with the team. Create with `wt config create --project`.
-Create `.config/wt.toml` in the repository root:
+See [`wt hook`](@/hook.md) for hook types, execution order, template variables, and examples.
-```toml
-[post-create]
-install = "npm ci"
-
-[pre-merge]
-test = "npm test"
-lint = "npm run lint"
-```
-
-See [`wt hook`](@/hook.md) for complete documentation on hook types, execution order, template variables, and [JSON context](@/hook.md#json-context).
-
-### Dev server URL
-
-The `[list]` section adds a URL column to `wt list`:
+### Non-hook settings
```toml
+# .config/wt.toml
+
+# URL column in wt list (dimmed when port not listening)
[list]
url = "http://localhost:{{ branch | hash_port }}"
-```
-
-URLs are dimmed when the port isn't listening.
-### CI platform override
-
-The `[ci]` section overrides CI platform detection for GitHub Enterprise or self-hosted GitLab with custom domains:
-
-```toml
+# Override CI platform detection for self-hosted instances
[ci]
platform = "github" # or "gitlab"
```
-By default, the platform is detected from the remote URL. Use this when URL detection fails (e.g., `git.mycompany.com` instead of `github.mycompany.com`).
-
---
## Shell integration
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 23486b37e..e5f801b1a 100644
--- a/tests/snapshots/integration__integration_tests__help__help_config_long.snap
+++ b/tests/snapshots/integration__integration_tests__help__help_config_long.snap
@@ -292,39 +292,24 @@ Default template:
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
-Worktrunk Project Configuration
+Project configuration
-The project config defines lifecycle hooks and project-specific settings. This file is checked into version control and shared across the team.
+Project config (.config/wt.toml) defines lifecycle hooks and project-specific settings. This file is checked into version control and shared with the team. Create with wt config create --project.
-Create .config/wt.toml in the repository root:
+See wt hook for hook types, execution order, template variables, and examples.
- [post-create]
- install = "npm ci"
- 
- [pre-merge]
- test = "npm test"
- lint = "npm run lint"
-
-See wt hook for complete documentation on hook types, execution order, template variables, and JSON context.
-
-Dev server URL
-
-The [list] section adds a URL column to wt list:
+Non-hook settings
+ # .config/wt.toml
+ 
+ # URL column in wt list (dimmed when port not listening)
[list]
url = "http://localhost:{{ branch | hash_port }}"
-
-URLs are dimmed when the port isn't listening.
-
-CI platform override
-
-The [ci] section overrides CI platform detection for GitHub Enterprise or self-hosted GitLab with custom domains:
-
+ 
+ # Override CI platform detection for self-hosted instances
[ci]
platform = "github" # or "gitlab"
-By default, the platform is detected from the remote URL. Use this when URL detection fails (e.g., git.mycompany.com instead of github.mycompany.com).
-
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
Shell integration