GitHub CLI extension for managing repositories that use a bare-git worktree layout.
gh wt keeps one bare repository in .bare/ and checks branches out as sibling
worktree directories:
repo/
├── .bare/
├── main/
├── feature-a/
└── feature-b/
Install from GitHub:
gh extension install williamw/gh-wtFor local development, clone and install from the working copy:
git clone https://github.com/williamw/gh-wt.git
cd gh-wt
gh extension install .Clone a repository into the .bare/ layout and create the default branch worktree:
gh wt clone owner/repoAdd a worktree for a branch:
gh wt add feature-branchBranch names with slashes keep the branch name intact and use the final path segment as the folder name:
gh wt add user/feature-branch
# folder: feature-branch
# branch: user/feature-branchUse --branch-name when the folder name should differ from the branch name:
gh wt add feature-branch --branch-name user/feature-branch
gh wt add feature-branch -b user/feature-branch--base-branch controls the source branch for new worktrees. It does not rename
the new branch. Use -B as the short form:
gh wt add feature-branch --base-branch main
gh wt add feature-branch -B main--local creates a branch locally without pushing to origin. Use -l as the
short form:
gh wt add feature-branch --local
gh wt add feature-branch -lAfter a worktree is created, gh wt add looks in the current directory for an
executable setup-worktree.sh and runs it with the new worktree folder name:
./setup-worktree.sh feature-branchIf the setup script exits non-zero, gh wt add exits non-zero too. The created
worktree is left in place.
Remove a worktree:
gh wt rm feature-branchrm resolves the actual checked-out branch from the worktree before deleting
the local branch, so the folder name does not need to match the branch name. Add
-d or --delete-remote to delete the resolved branch from origin too. If
the resolved branch is already missing from origin, rm warns and continues:
gh wt rm feature-branch -dRemove all worktrees whose associated pull requests are merged or closed:
gh wt rm --mergedUse --force to bypass the local branch safety check when you know you want to
delete a worktree with unpushed or untracked work.
If Git refuses to remove a worktree because it contains submodules, gh wt rm
deinitializes submodules in that worktree and retries with --force before
deleting the branch.
gh wt rm <folder> can also remove Git-registered worktrees outside the repo
root, such as temporary worktrees under /private/tmp, by matching the folder
basename shown by gh wt status. If that worktree is detached, gh wt rm
removes the worktree only and skips local or remote branch deletion.
If the worktree folder was already deleted but Git still has stale worktree
metadata for that folder, gh wt rm <folder> automatically runs
git worktree prune -v to clear the stale record. This cleanup does not delete
local or remote branches because the checked-out branch can no longer be safely
resolved from the missing worktree.
List worktrees:
gh wt listShow status for all worktrees:
gh wt status- GitHub CLI (
gh) - Git
- Python 3.10+
- Bare-git layout created by
gh wt clone, or an existing repo with.bare/
Install dependencies:
pixi installRun tests:
pixi run testInstall the local checkout as the active gh wt extension:
gh extension remove gh-wt 2>/dev/null || true
gh extension install .
gh wt --help