PHPackages                             jeffersongoncalves/git-worktree-cli - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. jeffersongoncalves/git-worktree-cli

ActiveProject[CLI & Console](/categories/cli)

jeffersongoncalves/git-worktree-cli
===================================

CLI tool to audit git worktrees and check whether their branches have been merged into the main branch.

1.0.6(1mo ago)313MITPHPPHP ^8.2CI passing

Since Apr 16Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/jeffersongoncalves/git-worktree-cli)[ Packagist](https://packagist.org/packages/jeffersongoncalves/git-worktree-cli)[ Docs](https://github.com/jeffersongoncalves/git-worktree-cli)[ GitHub Sponsors](https://github.com/jeffersongoncalves)[ RSS](/packages/jeffersongoncalves-git-worktree-cli/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (10)Dependencies (15)Versions (13)Used By (0)

[![Git Worktree CLI](https://raw.githubusercontent.com/jeffersongoncalves/git-worktree-cli/main/art/jeffersongoncalves-git-worktree-cli.png)](https://raw.githubusercontent.com/jeffersongoncalves/git-worktree-cli/main/art/jeffersongoncalves-git-worktree-cli.png)

git-worktree-cli
================

[](#git-worktree-cli)

CLI tool to audit git worktrees in a repository and report whether each worktree's branch has already been merged into the main branch. Includes a `clean` command to remove merged worktrees and keep the workspace tidy.

Built with [Laravel Zero](https://laravel-zero.com) and modeled on the other CLIs in this monorepo.

Requirements
------------

[](#requirements)

- PHP `^8.2`
- `git` available on `PATH`
- A git repository with at least one linked worktree

Install
-------

[](#install)

### Global (recommended)

[](#global-recommended)

```
composer global require jeffersongoncalves/git-worktree-cli
```

The binary `git-worktree` will be on your `PATH` as long as Composer's global `vendor/bin` is in it.

### From source

[](#from-source)

```
git clone https://github.com/jeffersongoncalves/git-worktree-cli.git
cd git-worktree-cli
composer install
```

Usage
-----

[](#usage)

```
# Audit the current directory (the default command)
git-worktree

# Audit a specific repo
git-worktree check /path/to/repo

# Force a specific main branch (otherwise auto-detected)
git-worktree check --main=develop

# Only show worktree branches that are NOT merged
git-worktree check --only-unmerged
```

### Add a worktree

[](#add-a-worktree)

```
# Existing local branch — creates /-
git-worktree add feature

# Branch with a slash — uses the suffix after the last "/"
# (feature/foo → /-foo)
git-worktree add feature/foo

# Existing remote branch — auto-tracks origin/
git-worktree add hotfix/login

# Brand-new branch from the auto-detected main (skip prompt)
git-worktree add my-new-feature --yes

# Custom base ref + custom target directory
git-worktree add my-feat --from=develop --target=/tmp/wt-myfeat

# Skip the network check (use only local refs)
git-worktree add my-feat --no-fetch

# Skip recursive submodule init in the new worktree
git-worktree add my-feat --no-submodules

# Copy untracked files (e.g. .env) from the main worktree into the new one
git-worktree add my-feat --copy=.env --copy=auth.json

# Run setup commands inside the new worktree after creation
git-worktree add my-feat --run='composer install' --run='php artisan key:generate'

# Ignore the per-repo add.copy / add.run config for this run
git-worktree add my-feat --no-config
```

Resolution order: existing local branch → existing remote branch (creates a tracking branch) → new branch from `--from` or the auto-detected main.

If the repository declares submodules (a `.gitmodules` file is present), the new worktree runs `git submodule update --init --recursive` automatically. Disable this with `--no-submodules`.

`--copy` and `--run` make a new worktree usable immediately: copy the local config a fresh checkout lacks (`.env`, `auth.json`, signing keys) and run setup commands (`composer install`, …). Both can be made persistent per repo via the `add` section of the config file (see [Per-repo config](#protected-branches)):

```
{
    "add": {
        "copy": [".env", "auth.json"],
        "run": ["composer install"]
    }
}
```

### Clean merged worktrees

[](#clean-merged-worktrees)

```
# Preview — doesn't touch anything
git-worktree clean --dry-run

# Prompt to confirm, then remove
git-worktree clean

# Skip confirmation + also delete the local branch
git-worktree clean --yes --delete-branch

# Force removal (worktrees with dirty state, branches with -D)
git-worktree clean --yes --delete-branch --force

# Only remove branches directly merged (exclude squash/rebase detection)
git-worktree clean --strict

# Never remove these branches, even if merged (repeatable, globs allowed)
git-worktree clean --protect=develop --protect=release/*

# Ignore the per-repo protected-branches config file for this run
git-worktree clean --no-config
```

### Protected branches

[](#protected-branches)

Some branches stay merged but should never be cleaned (long-lived `develop`, `staging`, `release/*`, …). The main branch is always skipped automatically; protection is for the *extra* branches you want to keep.

Two ways to protect, combined as a union on every `clean` run:

1. **Per-run flag** — `--protect=` (repeatable).
2. **Per-repo config file** — persistent, managed with `config:*` commands.

```
# Add / remove protected branches (exact names or globs)
git-worktree config:protect develop
git-worktree config:protect 'release/*'
git-worktree config:unprotect develop

# Inspect the resolved config (slug, file path, enabled flag, branch list)
git-worktree config:show

# Turn the file off / on without losing its contents
git-worktree config:disable
git-worktree config:enable
```

The config lives at `~/.config/git-worktree/-.json`(honoring `XDG_CONFIG_HOME`; the slug is derived from the `origin` remote, falling back to the directory name plus a short hash when there is no remote):

```
{
    "protect": {
        "enabled": true,
        "branches": ["develop", "release/*", "staging"]
    }
}
```

`--no-config` ignores the file for a single run; `config:disable` (or `"enabled": false`) turns it off persistently. Either way, `--protect` flags still apply.

### Remove a single worktree

[](#remove-a-single-worktree)

`clean` removes *merged* worktrees in bulk; `remove` targets one by branch name or path, regardless of merge status:

```
# Remove by branch name (prompts; refuses if dirty)
git-worktree remove feature/login

# Skip confirmation and also delete the local branch
git-worktree remove feature/login --yes --delete-branch

# Force removal of a worktree with uncommitted changes
git-worktree remove feature/login --force --yes
```

### List worktrees

[](#list-worktrees)

```
# Basic listing
git-worktree list-worktrees

# Include merge status against the main branch and a clean/dirty flag
git-worktree list-worktrees --status
```

### Prune stale records

[](#prune-stale-records)

After a worktree directory is deleted manually, git keeps a stale admin record. Clear them:

```
git-worktree prune            # remove stale records
git-worktree prune --dry-run  # show what would be pruned
```

### Jump to a worktree (shell integration)

[](#jump-to-a-worktree-shell-integration)

`path` prints a worktree's absolute path so your shell can `cd` into it:

```
cd "$(git-worktree path feature/login)"
```

Install the `gwt` helper so `gwt cd ` changes directory for you:

```
# bash / zsh — add to ~/.bashrc or ~/.zshrc
eval "$(git-worktree shell-init)"

# fish — add to ~/.config/fish/config.fish
git-worktree shell-init fish | source
```

Then: `gwt cd feature/login`. Any other `gwt ` forwards to `git-worktree`.

### Open a worktree in your editor

[](#open-a-worktree-in-your-editor)

```
git-worktree open feature/login                 # uses $VISUAL, $EDITOR, then "code"
git-worktree open feature/login --editor=subl
```

### Keep the CLI up to date

[](#keep-the-cli-up-to-date)

When installed from the released PHAR, self-update from the terminal:

```
git-worktree self-update          # download and install the latest release
git-worktree self-update --check  # only check, don't install
```

When installed via Composer, use Composer to update:

```
composer global update jeffersongoncalves/git-worktree-cli
```

How the merge check works
-------------------------

[](#how-the-merge-check-works)

For each linked worktree (the main worktree and bare repos are skipped) the tool inspects the branch checked out in that worktree and compares it to the main branch:

1. If the worktree is detached or on the main branch itself, it is skipped.
2. If branch tip equals main tip → **same as main**.
3. If branch tip is an ancestor of main (direct/fast-forward/merge commit) → **merged**.
4. Otherwise `git cherry main branch` is used to detect **squash/rebase merges** — if every commit on the branch has an equivalent patch on main, the branch is considered merged.
5. Anything else is reported as **not merged**.

`ahead/behind` counts come from `git rev-list --left-right --count`between the branch and the main branch.

Main branch detection
---------------------

[](#main-branch-detection)

In order of priority:

1. `--main=` flag if provided and the ref exists
2. The remote default branch (`origin/HEAD`)
3. Conventional names: `main`, `master`, `develop`, `trunk`

Validation
----------

[](#validation)

The command fails fast when:

- The target path is not a git repository
- The repository has no linked worktrees (only the main checkout)
- The main branch cannot be resolved

Development
-----------

[](#development)

```
composer install
composer test       # Pest tests + Pint lint
composer lint       # Auto-fix style
composer build      # Build the PHAR into builds/git-worktree
```

The PHAR is emitted at `builds/git-worktree`. The `build.yml` workflow rebuilds and commits it back to `main` on every push, using the latest git tag as the embedded version.

Fresh git repositories used by the test suite are created under `tests/tmp/` (which is gitignored).

Release
-------

[](#release)

1. Merge changes to `main` — CI builds a fresh `builds/git-worktree`against the latest tag and commits it back.
2. Create a new GitHub release (tag `X.Y.Z`, no `v` prefix).
3. The `publish-phar.yml` workflow attaches `git-worktree.phar` to the release and `update-changelog.yml` updates `CHANGELOG.md` + `version.txt`.

The `self-update` command pulls the PHAR asset from the latest release.

###  Health Score

43

—

FairBetter than 89% of packages

Maintenance91

Actively maintained with recent releases

Popularity11

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~6 days

Total

12

Last Release

30d ago

Major Versions

v0.0.5 → 1.0.02026-05-07

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/411493?v=4)[Jefferson Gonçalves](/maintainers/jeffersongoncalves)[@jeffersongoncalves](https://github.com/jeffersongoncalves)

---

Top Contributors

[![jeffersongoncalves](https://avatars.githubusercontent.com/u/411493?v=4)](https://github.com/jeffersongoncalves "jeffersongoncalves (43 commits)")

---

Tags

cligitgit-worktreelaravel-zeromerge-checkpharphpworkspace-cleanupworktreecligitmergeworktreebranches

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/jeffersongoncalves-git-worktree-cli/health.svg)

```
[![Health](https://phpackages.com/badges/jeffersongoncalves-git-worktree-cli/health.svg)](https://phpackages.com/packages/jeffersongoncalves-git-worktree-cli)
```

###  Alternatives

[symfony/console

Eases the creation of beautiful and testable command line interfaces

9.8k1.1B14.3k](/packages/symfony-console)[nunomaduro/collision

Cli error handling for console/command-line PHP applications.

4.7k357.7M11.5k](/packages/nunomaduro-collision)[nunomaduro/termwind

It's like Tailwind CSS, but for the console.

2.5k271.5M393](/packages/nunomaduro-termwind)[wp-cli/wp-cli

WP-CLI framework

5.1k19.2M415](/packages/wp-cli-wp-cli)[wp-cli/php-cli-tools

Console utilities for PHP

68227.8M376](/packages/wp-cli-php-cli-tools)[projektgopher/whisky

A simple CLI tool for managing a project's git hooks across multiple members.

242362.3k25](/packages/projektgopher-whisky)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)