gh-worktree 0.2.2

github CLI extension for worktrees

gh-worktree

A CLI tool that helps you manage Git worktrees. This was built as a GitHub CLI (gh) extension, but it can be used directly. Although it does rely on the following being available:

• git (obviously)
• gh

Quick Start

pip install gh-worktree

Or

uvx gh-worktree

Or download the PEX file from the releases page.

View my recipes for hooks and templates here.

Overview

Features

• Bare repository initialization
• Lifecycle hooks with script checksum validation
• Global and project configuration
• Create worktrees from GitHub PRs
• Project hook and template initialization
• Worktree templates
• Terminal autocomplete (coming soon)
• Feature detection and hook bifurcation (planned)

Details

When you use gh-worktree to initialize a repository for use with worktrees, it uses a bare repository approach, which creates a structure like the following, if you were to clone gh-worktree:

gh-worktree/
  .bare/
  .git # points git to .bare/
  .gh/
    worktree/
      hooks/
      templates/
      config.json

When you create new worktrees, they'll be added as directories to the root directory:

gh-worktree/
  # ... see above ...
  my-new-worktree/
    README.md
    # ... etc ...

When you initialize a new project, if gh-worktree detects that .gh/worktree exists in the main branch of the repo, it will copy any hooks and/or templates from there to the project repo directory. This project has templates which would get copied if you use gh-worktree with it.

Hooks

You may add hooks to .gh/worktree/hooks so that you may trigger custom functionality during the lifecycle of your worktrees. The hooks are configurable in the project, but also globally. The first global .gh/worktree/hooks found upwards in the directory tree, outside the project directory (i.e. above gh-worktree/), will be executed. The following hooks are available:

• pre_init: before initializing a repository for use with worktrees (global only)
• post_init: after initializing a repository for use with worktrees (global only)
• pre_checkout: before a PR or other existing branch is checked out as a worktree
• post_checkout: after a PR or other existing branch is checked out as a worktree
• pre_create: before a new worktree (branch) is created
• post_create: after a new worktree (branch) is created
• pre_remove: before a worktree is removed
• post_remove: after a worktree is removed

For example, you might consider adding a post_create hook for this project like:

#!/usr/bin/env bash

WORKTREE_NAME="$1"
BASE_REF="$2" # format: `remote/branch`

pushd "$WORKTREE_NAME"

uv venv
uv sync --group dev

popd

Templates

You may add files to .gh/worktree/templates which will get copied into new worktrees. The files are copied before the post-hooks are executed. It's a good idea to add these files to the project's .gitignore. The files can optionally contain variables that will be replaced during the copy process. The variables should be defined like environment variables: ${ENVVAR_NAME}. To allowlist environment variables for use in templates, add their names to the allowed_envvars list in your global config (probably ~/.gh/worktree/config.json). The following are variables that are provided by default:

• REPO_NAME: the name of the git repository
• REPO_DIR: the absolute path of the repo / project directory
• WORKTREE_NAME: the name of the new worktree
• WORKTREE_DIR: the absolute path of the worktree directory

Commands

You may use --help for any command for usage information. To see a list of commands, run gh-worktree without any arguments.

Init

Spec: init <repository_uri> [optional_clone_dir]

Initializes the repository (e.g. https://github.com/bjester/gh-worktree.git) for use with this plugin and git worktrees. It's similar to git clone in that you can specify a name for the project directory as the second argument, otherwise it uses the repository name.

Create

Spec: create <worktree_name> [base_ref]

Creates a new worktree, which by default will be based off the default branch of the GitHub repository that you initialized the project with using init.

Checkout

Spec: checkout [--remote=<name>] <branch_name|pr_number|pr_url>

Similar to how gh lets you quickly checkout PRs, this command allows you to quickly create a worktree for a PR. This works even if the PR was opened from a fork of the project, and regardless of whether you've configured the fork as a remote.

Remove

Spec: remove [--force] <worktree_name>

Removes a worktree. If git detects the worktree has commits that are unmerged, then it will refuse to delete it. You may use --force to passthrough --force to git and force the worktree's deletion.

Installation

Most GitHub extensions are precompiled Go or Node.js executables, but you can use this standalone. gh-worktree has only been tested on Linux so far. If you have python 3.10+ installed, the PEX file is a great option.

As a GitHub CLI extension (gh)

The following will copy the binary to ~/.local/share/gh/extensions/gh-worktree/gh-worktree. You can also use the PEX file, just remove the extension before step 3.

1. Download the latest release's binary file.
2. Ensure it's executable: chmod +x gh-worktree
3. Execute the following: ./gh-worktree install --gh-ext
4. Test it: gh worktree

Standalone

1. Download the latest release's binary or PEX file.
2. Ensure it's executable: chmod +x gh-worktree*
3. Execute the following: ./gh-worktree install --path-bin or ./gh-worktree.pex install --path-bin
4. Test it: gh-worktree version

Aliasing

Use the --alias flag to change the name for either of the above options:

./gh-worktree install --alias=wktr --path-bin
wktr version

From source

git clone https://github.com/bjester/gh-worktree.git
cd gh-worktree
uv venv
source .venv/bin/activate
uv sync --group dev
make dist/gh-worktree
./dist/gh-worktree install --path-bin

AI Disclosure

LLMs were used in the development of this project, mostly for brainstorming and bootstrapping code, particularly tests. The contribution proportion is roughly 80 / 20, human and AI code respectively.

License

MIT :: Copyright 2026 Blaine Jester