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.mdindex 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 integrationdiff --git a/docs/content/config.md b/docs/content/config.mdindex 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 integrationdiff --git a/src/cli/mod.rs b/src/cli/mod.rsindex 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 integrationdiff --git a/tests/snapshots/integration__integration_tests__help__help_config_long.snap b/tests/snapshots/integration__integration_tests__help__help_config_long.snapindex 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:[2m────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────[0m-[1m[32mWorktrunk Project Configuration[0m+[1m[32mProject configuration[0m-The project config defines lifecycle hooks and project-specific settings. This file is checked into version control and shared across the team.+Project config ([2m.config/wt.toml[0m) defines lifecycle hooks and project-specific settings. This file is checked into version control and shared with the team. Create with [2mwt config create --project[0m.-Create [2m.config/wt.toml[0m in the repository root:+See [2mwt hook[0m for hook types, execution order, template variables, and examples.- [2m[post-create][0m- [2minstall = "npm ci"[0m- [2m[0m- [2m[pre-merge][0m- [2mtest = "npm test"[0m- [2mlint = "npm run lint"[0m--See [2mwt hook[0m for complete documentation on hook types, execution order, template variables, and JSON context.--[32mDev server URL[0m--The [2m[list][0m section adds a URL column to [2mwt list[0m:+[32mNon-hook settings[0m+ [2m# .config/wt.toml[0m+ [2m[0m+ [2m# URL column in wt list (dimmed when port not listening)[0m[2m[list][0m[2murl = "http://localhost:{{ branch | hash_port }}"[0m--URLs are dimmed when the port isn't listening.--[32mCI platform override[0m--The [2m[ci][0m section overrides CI platform detection for GitHub Enterprise or self-hosted GitLab with custom domains:-+ [2m[0m+ [2m# Override CI platform detection for self-hosted instances[0m[2m[ci][0m[2mplatform = "github" # or "gitlab"[0m-By default, the platform is detected from the remote URL. Use this when URL detection fails (e.g., [2mgit.mycompany.com[0m instead of [2mgithub.mycompany.com[0m).-[2m────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────[0m[1m[32mShell integration[0m