worktrunk
Guidance for Worktrunk, a CLI tool for managing git worktrees. Covers configuration (user config at ~/.config/worktrunk/config.toml and project hooks at .config/wt.toml), usage, and troubleshooting. Use for "setting up LLM", "configuring hooks", "automating tasks", or general worktrunk questions.
Security Assessment
Detected risks:
About worktrunk
Worktrunk is a command-line interface (CLI) tool designed to help developers manage git worktrees effectively. It simplifies configuration, task automation, and integration with commit message generation systems. By leveraging two separate configuration files, Worktrunk streamlines both personal and team-wide workflows, making it ideal for individuals and teams working with complex git repositories. This tool facilitates tasks like setting up commit message generation, configuring project-specific hooks, automating quality checks, and managing worktree creation paths, providing a comprehensive solution for optimizing git-based development processes.
FAQ
How do I set up commit message generation with Worktrunk?
To set up commit message generation, detect available tools like Claude, Codex, or LLM using the command `which claude codex llm aichat`. If no tools are found, you can install Claude Code. Once detected, you will need to modify your user configuration file (`~/.config/worktrunk/config.toml`) by adding the specific commit generation command. Follow the steps in `reference/llm-commits.md` for detailed instructions.
What are the different types of configuration in Worktrunk?
Worktrunk uses two types of configuration: User Config (`~/.config/worktrunk/config.toml`) for personal preferences, such as commit message generation and worktree path settings, and Project Config (`.config/wt.toml`) for team-wide automation, such as setting up project-specific hooks for lifecycle tasks like post-create or pre-merge.
Can I automate tasks like running tests or installing dependencies with Worktrunk?
Yes, you can automate tasks using project hooks. For example, you can set up hooks to run tests before a merge or automate `npm install` for a JavaScript project. This is configured in the `project config` file (`.config/wt.toml`) and allows developers to set up team-wide automation workflows.
Is Worktrunk compatible with all types of git repositories?
Worktrunk works with any git repository, but the specific configuration for automation and hooks may depend on the project type (e.g., npm for JavaScript, cargo for Rust). The tool detects the project type based on the presence of files like `package.json`, `Cargo.toml`, or `pyproject.toml` and configures tasks accordingly.
What happens if I don’t have the necessary permissions for modifying the configuration files?
For User Config, changes are always proposed and require consent before being applied. For Project Config, changes are proactive, but they can be easily reversed via git if needed. Both configurations ensure that proper consent and version control are in place to avoid unintended modifications.
Install worktrunk
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
max-sixty/worktrunk