gtr - Git Worktree Runner

A portable, cross-platform CLI for managing git worktrees with ease

What are git worktrees?

ELI5: Normally, you can only work on one git branch at a time in a folder. Want to fix a bug while working on a feature? You have to stash changes, switch branches, then switch back. Git worktrees let you have multiple branches checked out at once in different folders - like having multiple copies of your project, each on a different branch.

The Problem: Everyone's using git worktrees wrong (or not at all):

🔄 Constantly stashing/switching branches disrupts flow
🤹 Running tests on main while working on features requires manual copying
👥 Reviewing PRs means stopping current work
🤖 Parallel AI agents on different branches? Nearly impossible without worktrees

Why people sleep on worktrees: The DX is terrible. git worktree add ../my-project-feature feature is verbose, manual, and error-prone.

Enter gtr: Simple commands, AI tool integration, automatic setup, and built for modern parallel development workflows.

Quick Start

Install (30 seconds):

git clone https://github.com/coderabbitai/git-worktree-runner.git
cd git-worktree-runner
sudo ln -s "$(pwd)/bin/gtr" /usr/local/bin/gtr

Use it (3 commands):

cd ~/your-repo                              # Navigate to git repo
gtr config set gtr.editor.default cursor    # One-time setup
gtr config set gtr.ai.default claude        # One-time setup

# Daily workflow
gtr new my-feature                          # Create worktree
gtr editor my-feature                       # Open in editor
gtr ai my-feature                           # Start AI tool
gtr rm my-feature                           # Remove when done

Why gtr?

While git worktree is powerful, it's verbose and manual. gtr adds quality-of-life features for modern development:

Task	With `git worktree`	With `gtr`
Create worktree	`git worktree add ../repo-feature feature`	`gtr new feature`
Open in editor	`cd ../repo-feature && cursor .`	`gtr editor feature`
Start AI tool	`cd ../repo-feature && aider`	`gtr ai feature`
Copy config files	Manual copy/paste	Auto-copy via `gtr.copy.include`
Run build steps	Manual `npm install && npm run build`	Auto-run via `gtr.hook.postCreate`
List worktrees	`git worktree list` (shows paths)	`gtr list` (shows branches + status)
Clean up	`git worktree remove ../repo-feature`	`gtr rm feature`

TL;DR: gtr wraps git worktree with quality-of-life features for modern development workflows (AI tools, editors, automation).

Features

🚀 Simple commands - Create and manage worktrees with intuitive CLI
📁 Repository-scoped - Each repo has independent worktrees
🔧 Configuration over flags - Set defaults once, use simple commands
🎨 Editor integration - Open worktrees in Cursor, VS Code, Zed, and more
🤖 AI tool support - Launch Aider, Claude Code, or other AI coding tools
📋 Smart file copying - Selectively copy configs/env files to new worktrees
🪝 Hooks system - Run custom commands after create/remove
🌍 Cross-platform - Works on macOS, Linux, and Windows (Git Bash)
🎯 Shell completions - Tab completion for Bash, Zsh, and Fish

Quick Start

# Navigate to your git repo
cd ~/GitHub/my-project

# One-time setup (per repository)
gtr config set gtr.editor.default cursor
gtr config set gtr.ai.default claude

# Daily workflow
gtr new my-feature          # Create worktree folder: my-feature
gtr editor my-feature       # Open in cursor
gtr ai my-feature           # Start claude

# Navigate to worktree
cd "$(gtr go my-feature)"

# List all worktrees
gtr list

# Remove when done
gtr rm my-feature

Requirements

Git 2.5+ (for git worktree support)
Bash 3.2+ (macOS ships 3.2; 4.0+ recommended for advanced features)

Installation

Quick Install (macOS/Linux)

# Clone the repository
git clone https://github.com/coderabbitai/git-worktree-runner.git
cd git-worktree-runner

# Add to PATH (choose one)
# Option 1: Symlink to /usr/local/bin
sudo ln -s "$(pwd)/bin/gtr" /usr/local/bin/gtr

# Option 2: Add to your shell profile
echo 'export PATH="$PATH:'$(pwd)'/bin"' >> ~/.zshrc  # or ~/.bashrc
source ~/.zshrc

Shell Completions (Optional)

Bash (requires bash-completion v2):

# Install bash-completion first (if not already installed)
# macOS:
brew install bash-completion@2

# Ubuntu/Debian:
sudo apt install bash-completion

# Then enable gtr completions:
echo 'source /path/to/git-worktree-runner/completions/gtr.bash' >> ~/.bashrc
source ~/.bashrc

Zsh:

echo 'source /path/to/git-worktree-runner/completions/_gtr' >> ~/.zshrc

Fish:

ln -s /path/to/git-worktree-runner/completions/gtr.fish ~/.config/fish/completions/

Commands

Commands accept branch names to identify worktrees. Use 1 to reference the main repo. Run gtr help for full documentation.

`gtr new <branch> [options]`

Create a new git worktree. Folder is named after the branch.

gtr new my-feature                              # Creates folder: my-feature
gtr new hotfix --from v1.2.3                    # Create from specific ref
gtr new feature/auth                            # Creates folder: feature-auth
gtr new feature-auth --name backend --force     # Same branch, custom name
gtr new my-feature --name descriptive-variant   # Optional: custom name without --force

Options:

--from <ref>: Create from specific ref
--track <mode>: Tracking mode (auto|remote|local|none)
--no-copy: Skip file copying
--no-fetch: Skip git fetch
--force: Allow same branch in multiple worktrees (requires --name)
--name <suffix>: Custom folder name suffix (optional, required with --force)
--yes: Non-interactive mode

`gtr editor <branch> [--editor <name>]`

Open worktree in editor (uses gtr.editor.default or --editor flag).

gtr editor my-feature                    # Uses configured editor
gtr editor my-feature --editor vscode    # Override with vscode

`gtr ai <branch> [--ai <name>] [-- args...]`

Start AI coding tool (uses gtr.ai.default or --ai flag).

gtr ai my-feature                      # Uses configured AI tool
gtr ai my-feature --ai aider          # Override with aider
gtr ai my-feature -- --model gpt-4    # Pass arguments to tool
gtr ai 1                              # Use AI in main repo

`gtr go <branch>`

Print worktree path for shell navigation.

cd "$(gtr go my-feature)"    # Navigate by branch name
cd "$(gtr go 1)"             # Navigate to main repo

`gtr rm <branch>... [options]`

Remove worktree(s) by branch name.

gtr rm my-feature                              # Remove one
gtr rm feature-a feature-b                     # Remove multiple
gtr rm my-feature --delete-branch --force      # Delete branch and force

Options: --delete-branch, --force, --yes

`gtr list [--porcelain]`

List all worktrees. Use --porcelain for machine-readable output.

`gtr config {get|set|add|unset} <key> [value] [--global]`

Manage configuration via git config.

gtr config set gtr.editor.default cursor       # Set locally
gtr config set gtr.ai.default claude --global  # Set globally
gtr config get gtr.editor.default              # Get value

Other Commands

gtr doctor - Health check (verify git, editors, AI tools)
gtr adapter - List available editor & AI adapters
gtr clean - Remove stale worktrees
gtr version - Show version

Configuration

All configuration is stored via git config, making it easy to manage per-repository or globally.

Worktree Settings

# Base directory for worktrees
# Default: <repo-name>-worktrees (sibling to repo)
# Supports: absolute paths, repo-relative paths, tilde expansion
gtr.worktrees.dir = <path>

# Examples:
# Absolute path
gtr.worktrees.dir = /Users/you/all-worktrees/my-project

# Repo-relative (inside repository - requires .gitignore entry)
gtr.worktrees.dir = .worktrees

# Home directory (tilde expansion)
gtr.worktrees.dir = ~/worktrees/my-project

# Folder prefix (default: "")
gtr.worktrees.prefix = dev-

# Default branch (default: auto-detect)
gtr.defaultBranch = main

Important

If storing worktrees inside the repository, add the directory to .gitignore.

echo "/.worktrees/" >> .gitignore

Editor Settings

# Default editor: cursor, vscode, zed, or none
gtr.editor.default = cursor

Setup editors:

Cursor: Install from cursor.com, enable shell command
VS Code: Install from code.visualstudio.com, enable code command
Zed: Install from zed.dev, zed command available automatically

AI Tool Settings

# Default AI tool: none (or aider, claude, codex, cursor, continue)
gtr.ai.default = none

Supported AI Tools:

Tool	Install	Use Case	Set as Default
Aider	`pip install aider-chat`	Pair programming, edit files with AI	`gtr config set gtr.ai.default aider`
Claude Code	Install from claude.com	Terminal-native coding agent	`gtr config set gtr.ai.default claude`
Codex CLI	`npm install -g @openai/codex`	OpenAI coding assistant	`gtr config set gtr.ai.default codex`
Cursor	Install from cursor.com	AI-powered editor with CLI agent	`gtr config set gtr.ai.default cursor`
Continue	See docs	Open-source coding agent	`gtr config set gtr.ai.default continue`

Examples:

# Set default AI tool for this repo
gtr config set gtr.ai.default claude

# Or set globally for all repos
gtr config set gtr.ai.default claude --global

# Then just use gtr ai
gtr ai my-feature

# Pass arguments to the tool
gtr ai my-feature -- --plan "refactor auth"

File Copying

Copy files to new worktrees using glob patterns:

# Add patterns to copy (multi-valued)
gtr config add gtr.copy.include "**/.env.example"
gtr config add gtr.copy.include "**/CLAUDE.md"
gtr config add gtr.copy.include "*.config.js"

# Exclude patterns (multi-valued)
gtr config add gtr.copy.exclude "**/.env"
gtr config add gtr.copy.exclude "**/secrets.*"

Warning

Be careful not to copy sensitive files. Use .env.example instead of .env.

Hooks

Run custom commands after worktree operations:

# Post-create hooks (multi-valued, run in order)
gtr config add gtr.hook.postCreate "npm install"
gtr config add gtr.hook.postCreate "npm run build"

# Post-remove hooks
gtr config add gtr.hook.postRemove "echo 'Cleaned up!'"

Environment variables available in hooks:

REPO_ROOT - Repository root path
WORKTREE_PATH - New worktree path
BRANCH - Branch name

Examples for different build tools:

# Node.js (npm)
gtr config add gtr.hook.postCreate "npm install"

# Node.js (pnpm)
gtr config add gtr.hook.postCreate "pnpm install"

# Python
gtr config add gtr.hook.postCreate "pip install -r requirements.txt"

# Ruby
gtr config add gtr.hook.postCreate "bundle install"

# Rust
gtr config add gtr.hook.postCreate "cargo build"

Configuration Examples

Minimal Setup (Just Basics)

gtr config set gtr.worktrees.prefix "wt-"
gtr config set gtr.defaultBranch "main"

Full-Featured Setup (Node.js Project)

# Worktree settings
gtr config set gtr.worktrees.prefix "wt-"

# Editor
gtr config set gtr.editor.default cursor

# Copy environment templates
gtr config add gtr.copy.include "**/.env.example"
gtr config add gtr.copy.include "**/.env.development"
gtr config add gtr.copy.exclude "**/.env.local"

# Build hooks
gtr config add gtr.hook.postCreate "pnpm install"
gtr config add gtr.hook.postCreate "pnpm run build"

Global Defaults

# Set global preferences
gtr config set gtr.editor.default cursor --global
gtr config set gtr.ai.default claude --global

Advanced Usage

How It Works: Repository Scoping

gtr is repository-scoped - each git repository has its own independent set of worktrees:

Run gtr commands from within any git repository
Worktree folders are named after their branch names
Each repo manages its own worktrees independently
Switch repos with cd, then run gtr commands for that repo

Working with Multiple Branches

# Terminal 1: Work on feature
gtr new feature-a
gtr editor feature-a

# Terminal 2: Review PR
gtr new pr/123
gtr editor pr/123

# Terminal 3: Navigate to main branch (repo root)
cd "$(gtr go 1)"  # Special ID '1' = main repo

Working with Multiple Repositories

Each repository has its own independent set of worktrees. Switch repos with cd:

# Frontend repo
cd ~/GitHub/frontend
gtr list
# BRANCH          PATH
# main [main]     ~/GitHub/frontend
# auth-feature    ~/GitHub/frontend-worktrees/auth-feature
# nav-redesign    ~/GitHub/frontend-worktrees/nav-redesign

gtr editor auth-feature      # Open frontend auth work
gtr ai nav-redesign          # AI on frontend nav work

# Backend repo (separate worktrees)
cd ~/GitHub/backend
gtr list
# BRANCH          PATH
# main [main]     ~/GitHub/backend
# api-auth        ~/GitHub/backend-worktrees/api-auth
# websockets      ~/GitHub/backend-worktrees/websockets

gtr editor api-auth          # Open backend auth work
gtr ai websockets            # AI on backend websockets

# Switch back to frontend
cd ~/GitHub/frontend
gtr editor auth-feature      # Opens frontend auth

Key point: Each repository has its own worktrees. Use branch names to identify worktrees.

Custom Workflows with Hooks

Create a .gtr-setup.sh in your repo:

#!/bin/sh
# .gtr-setup.sh - Project-specific gtr configuration

gtr config set gtr.worktrees.prefix "dev-"
gtr config set gtr.editor.default cursor

# Copy configs
gtr config add gtr.copy.include ".env.example"
gtr config add gtr.copy.include "docker-compose.yml"

# Setup hooks
gtr config add gtr.hook.postCreate "docker-compose up -d db"
gtr config add gtr.hook.postCreate "npm install"
gtr config add gtr.hook.postCreate "npm run db:migrate"

Then run: sh .gtr-setup.sh

Non-Interactive Automation

Perfect for CI/CD or scripts:

# Create worktree without prompts
gtr new ci-test --yes --no-copy

# Remove without confirmation
gtr rm ci-test --yes --delete-branch

Multiple Worktrees on Same Branch

Tip

Git normally prevents checking out the same branch in multiple worktrees to avoid conflicts. gtr supports bypassing this safety check with --force and --name flags.

Use cases:

Splitting work across multiple AI agents on one feature
Testing same branch in different environments/configs
Running parallel CI/build processes
Debugging without disrupting main worktree

Risks:

Concurrent edits in multiple worktrees can cause conflicts
Easy to lose work if not careful
Git's safety check exists for good reason

Using --force with --name (required):

# Create multiple worktrees for same branch with descriptive names
gtr new feature-auth                          # Main worktree: feature-auth/
gtr new feature-auth --force --name backend   # Creates: feature-auth-backend/
gtr new feature-auth --force --name frontend  # Creates: feature-auth-frontend/
gtr new feature-auth --force --name tests     # Creates: feature-auth-tests/

# All worktrees are on the same 'feature-auth' branch
# The --name flag is required with --force to distinguish worktrees

Example: Parallel AI development on one feature:

# Terminal 1: Backend work
gtr new feature-auth --force --name backend
gtr ai feature-auth-backend -- --message "Implement API endpoints"

# Terminal 2: Frontend work
gtr new feature-auth --force --name frontend
gtr ai feature-auth-frontend -- --message "Build UI components"

# Terminal 3: Tests
gtr new feature-auth --force --name tests
gtr ai feature-auth-tests -- --message "Write integration tests"

# All agents commit to the same feature-auth branch

Best practices when using --force:

Always provide a descriptive --name (backend, frontend, tests, ci, etc.)
Only edit files in one worktree at a time
Commit/stash changes before switching worktrees
Ideal for parallel AI agents working on different parts of one feature
Use gtr list to see all worktrees and their branches

Troubleshooting

Worktree Creation Fails

# Ensure you've fetched latest refs
git fetch origin

# Check if branch already exists
git branch -a | grep your-branch

# Manually specify tracking mode
gtr new test --track remote

Editor Not Opening

# Verify editor command is available
command -v cursor  # or: code, zed

# Check configuration
gtr config get gtr.editor.default

# Try opening again
gtr editor 2

File Copying Issues

# Check your patterns
gtr config get gtr.copy.include

# Test patterns with find
cd /path/to/repo
find . -path "**/.env.example"

Platform Support

✅ macOS - Full support (Ventura+)
✅ Linux - Full support (Ubuntu, Fedora, Arch, etc.)
✅ Windows - Via Git Bash or WSL

Platform-specific notes:

macOS: GUI opening uses open, terminal spawning uses iTerm2/Terminal.app
Linux: GUI opening uses xdg-open, terminal spawning uses gnome-terminal/konsole
Windows: GUI opening uses start, requires Git Bash or WSL

Architecture

git-worktree-runner/
├── bin/gtr              # Main executable
├── lib/                 # Core libraries
│   ├── core.sh         # Git worktree operations
│   ├── config.sh       # Configuration management
│   ├── platform.sh     # OS-specific code
│   ├── ui.sh           # User interface
│   ├── copy.sh         # File copying
│   └── hooks.sh        # Hook execution
├── adapters/           # Editor & AI tool plugins
│   ├── editor/
│   └── ai/
├── completions/        # Shell completions
└── templates/          # Example configs

Reliability & Testing Status

Current Status: Production-ready for daily use

Tested Platforms:

✅ macOS - Ventura (13.x), Sonoma (14.x), Sequoia (15.x)
✅ Linux - Ubuntu 22.04/24.04, Fedora 39+, Arch Linux
⚠️ Windows - Git Bash (tested), WSL2 (tested), PowerShell (not supported)

Git Versions:

✅ Git 2.25+ (recommended)
✅ Git 2.22+ (full support)
⚠️ Git 2.5-2.21 (basic support, some features limited)

Known Limitations:

Shell completions require bash-completion v2+ for Bash
Some AI adapters require recent tool versions (see adapter docs)
Windows native (non-WSL) support is experimental

Testing Approach:

Core functionality tested across macOS, Linux, WSL2
Manual testing with Cursor, VS Code, Aider, Claude Code
Used in production for parallel agent workflows
Community testing appreciated - please report issues!

Experimental Features:

--force flag for same-branch worktrees (use with caution)
Windows PowerShell support (use Git Bash or WSL instead)

Contributing

Contributions welcome! Areas where help is appreciated:

🎨 New editor adapters - JetBrains IDEs, Neovim, etc.
🤖 New AI tool adapters - Continue.dev, Codeium, etc.
🐛 Bug reports - Platform-specific issues
📚 Documentation - Tutorials, examples, use cases
✨ Features - Propose enhancements via issues

See CONTRIBUTING.md for guidelines.

Related Projects

git-worktree - Official git documentation
Aider - AI pair programming in your terminal
Cursor - AI-powered code editor

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Acknowledgments

Built to streamline parallel development workflows with git worktrees. Inspired by the need for simple, configurable worktree management across different development environments.

Happy coding with worktrees! 🚀

For questions or issues, please open an issue.

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
.github		.github
adapters		adapters
bin		bin
completions		completions
docs/assets		docs/assets
lib		lib
templates		templates
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CLAUDE.md		CLAUDE.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE.txt		LICENSE.txt
README.md		README.md

License

coderabbitai/git-worktree-runner

Folders and files

Latest commit

History

Repository files navigation

gtr - Git Worktree Runner

What are git worktrees?

Quick Start

Why gtr?

Features

Quick Start

Requirements

Installation

Quick Install (macOS/Linux)

Shell Completions (Optional)

Commands

gtr new <branch> [options]

gtr editor <branch> [--editor <name>]

gtr ai <branch> [--ai <name>] [-- args...]

gtr go <branch>

gtr rm <branch>... [options]

gtr list [--porcelain]

gtr config {get|set|add|unset} <key> [value] [--global]

Other Commands

Configuration

Worktree Settings

Editor Settings

AI Tool Settings

File Copying

Hooks

Configuration Examples

Minimal Setup (Just Basics)

Full-Featured Setup (Node.js Project)

Global Defaults

Advanced Usage

How It Works: Repository Scoping

Working with Multiple Branches

Working with Multiple Repositories

Custom Workflows with Hooks

Non-Interactive Automation

Multiple Worktrees on Same Branch

Troubleshooting

Worktree Creation Fails

Editor Not Opening

File Copying Issues

Platform Support

Architecture

Reliability & Testing Status

Contributing

Related Projects

License

Acknowledgments

Happy coding with worktrees! 🚀

About

Topics

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 1

Contributors 2

Uh oh!

Languages

`gtr new <branch> [options]`

`gtr editor <branch> [--editor <name>]`

`gtr ai <branch> [--ai <name>] [-- args...]`

`gtr go <branch>`

`gtr rm <branch>... [options]`

`gtr list [--porcelain]`

`gtr config {get|set|add|unset} <key> [value] [--global]`