Skip to content

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

docs: document installer PATH modification behavior (#599)

Maximilian Roos5b9a0a25cf5b
diff --git a/dist-workspace.toml b/dist-workspace.toml
index 75379c304..ef381e158 100644
--- a/dist-workspace.toml
+++ b/dist-workspace.toml
@@ -8,6 +8,12 @@ cargo-dist-version = "0.30.2"
# CI backends to support
ci = "github"
# The installers to generate for each app
+# Note: The shell/powershell scripts attempt to add the install directory to PATH by
+# modifying shell config files (.profile, .bashrc, etc.), which can cause "Permission
+# denied" errors on non-standard setups. This is cargo-dist's default behavior and
+# reasonable for most users. Users with custom shell configs can set
+# WORKTRUNK_NO_MODIFY_PATH=1 or use Homebrew/cargo install instead.
+# See: https://github.com/max-sixty/worktrunk/issues/590
installers = ["shell", "powershell", "homebrew"]
# Homebrew tap repository
tap = "max-sixty/homebrew-worktrunk"