English | 日本語

⚡ Switch Git contexts in milliseconds. Review pull requests, create feature branches, and clean up your workspace—all from a single interactive CLI.

When you're juggling multiple pull requests or hotfixes at once, running git checkout and git pull over and over or keeping multiple local clones around can slow you down. gwm leverages Git's native worktree feature and a pleasant UI to:

• ⚡ Swap tasks in milliseconds — no more stash/checkout dance
• 🎯 Spin up a worktree from any remote branch in one go
• 🧹 Keep your laptop squeaky-clean — detect and safely remove stale branches
• 🎨 Do it all without leaving the terminal — powered by an Ink-based interactive finder

Note: Run gwm help <command> for details on each command.

# Global install npm install -g @shutootaki/gwm # or use npx (no installation needed) npx @shutootaki/gwm

# Using pnpm pnpm add -g @shutootaki/gwm # Using yarn yarn global add @shutootaki/gwm # Using bun bun add -g @shutootaki/gwm

# In a Git repository $ gwm add # Interactive mode: enter branch name → Enter $ gwm go feature/my-branch # Jump to the worktree $ gwm go --code # Open VS Code instantly

When reviewing a pull request:

$ gwm add 1234-fix-layout -r --code # Create a worktree from the remote branch and open VS Code immediately 🚀

Weekend cleanup:

$ gwm clean # Clean up safe-to-delete worktrees interactively

~/git-worktrees/ └─ <repo-name>/ ├─ main/ ├─ feature-user-auth/ └─ hotfix-critical-bug/ 

You can change the base path in ~/.config/gwm/config.toml (or ~/.gwmrc).

Create ~/.config/gwm/config.toml to fine-tune behavior:

# Base path for worktrees (default: ~/git-worktrees) worktree_base_path = "/Users/me/dev/worktrees" # What to do with the local branch when deleting a worktree # "auto" – delete automatically when safe # "ask" – prompt for confirmation (default) # "never" – never delete clean_branch = "ask" # Copy gitignored files from main worktree (e.g., .env files) # By default, gitignored files cannot be copied to the new worktree. # Enable this setting to copy them to the new worktree. [copy_ignored_files] enabled = true # Enable/disable the feature patterns = [".env", ".env.*", ".env.local", ".env.*.local"] # Files to copy exclude_patterns = [".env.example", ".env.sample"] # Files to exclude

Below are the main commands. Run gwm <command> --help for more information.

List worktrees that belong to the current project.

STATUS BRANCH PATH HEAD * feature/new-ui /Users/me/project a1b2c3d M main ~/git-worktrees/project/main 123abc4 - hotfix/logfix ~/git-worktrees/project/logfix c7d8e9f 

• STATUS meanings:
  • * ACTIVE: The worktree you're currently in
  • M MAIN: Main branches such as main or master
  • - OTHER: Any other worktree

Create a new worktree. Comes with an interactive UI.

• Run without arguments (gwm add):

  • Launches a UI to type a new branch name. Branch names are validated in real time and the path preview is shown.
  • Press Tab to switch to mode for selecting a remote branch to create a worktree from—perfect for reviewing PRs.
  • You can pass flags to immediately open the worktree in VS Code or Cursor.

• Run with arguments:

  • gwm add feature/new-login: Create a new branch and worktree named feature/new-login.
  • gwm add existing-branch: Create a worktree from an existing local branch existing-branch.
  • gwm add pr-branch -r: Create a worktree from the remote branch origin/pr-branch.

• Key options:

  • -r, --remote: Switch to mode for creating from a remote branch.
  • --from <base_branch>: Base branch for new branches (default: main or master).
  • --code: Open in VS Code after creation.
  • --cursor: Open in Cursor after creation.
  • --cd: After creation, go to the directory where the corresponding work tree exists.

• Automatic file copying:

  • When copy_ignored_files is enabled in the config, gitignored files (like .env files) will be automatically copied from the main worktree to the new worktree.
  • This is useful for development environment files that need to be present but shouldn't be tracked by Git.

Find a worktree and jump into it (launches a subshell).

• Run gwm go for interactive selection or supply an initial query, e.g., gwm go feat.
• Key options:
  • --code, -c: Open the selected worktree in Visual Studio Code.
  • --cursor: Open the selected worktree in Cursor.

Interactively select and delete one or more worktrees.

• Run gwm remove to choose from a list and delete.
• Key options:
  • -f, --force: Delete even if there are uncommitted changes.
  • --clean-branch <mode>: Decide whether to delete the local branch along with the worktree (auto / ask / never).

Automatically detect and clean up worktrees that are safe to delete.

A worktree is eligible if:

1. The remote branch has been deleted or merged into the main branch
2. There are no local changes (uncommitted or unpushed commits)
3. It is not the main branch or the worktree you're currently in

• Key options:
  • -n, --dry-run: Show the list only; don't delete.
  • --force: Skip confirmation and delete immediately.

Regardless of where you are, find worktrees of main branches (main, master, etc.) and run git pull to bring them up to date.

# Reviewing a PR git stash # Save current work git checkout main # Switch to main git pull # Update main git checkout pr-branch # Switch to PR branch git pull origin pr-branch # Update PR branch # ... review work ... git checkout main # Back to main git stash pop # Restore work

# Reviewing a PR gwm add pr-branch -r # Create worktree from remote gwm go pr-branch # Jump to review # ... review work ... (your main work is untouched) gwm remove pr-branch # Clean up when done

• Run gwm help for general help
• Run gwm help <command> for specific command help
• Check the GitHub Issues for known problems
• Create a new issue if you encounter a bug

MIT © 2024 Shuto Otaki and contributors