Git Worktree Manager

English | 简体中文

Manage Git worktrees safely and efficiently inside Visual Studio Code.
Create, switch, and clean up worktrees without losing track of your branches.

Support 💖

If you enjoy this extension, consider giving it a star ⭐ and sharing it on social platforms like X.com—it really helps!

PayPal

微信

Why Git Worktree Manager? 🌟

Git worktrees make parallel development cleaner by isolating branches into separate directories,
but managing them manually can be tedious and error-prone.

Git Worktree Manager brings worktree management into VS Code,
helping you create, switch, and clean up worktrees safely while keeping your repository organized.

Manage multiple repositories effortlessly within VSCode.

Key Features 🎯

• Quick Worktree Switching: Switch between worktrees using Ctrl+Shift+R or the Source Control view.

  Switch branches seamlessly with a single command.

• Effortless Worktree Creation: Create new worktrees without touching the command line.

  Create a new worktree in seconds.

• Workspace Integration: Add worktrees to your VSCode workspace for easy access.

  Add worktrees to your workspace with a click.

• Favorites Management: Save frequently used worktrees for quick access.

  Drop worktrees to favorites for instant access.

• Copy Untracked Files: Automatically include untracked files when creating a new worktree.
• Multi-Language Support: Available in English, Simplified Chinese, Traditional Chinese and Japanese.
• Customizable Terminal: Use your preferred terminal (e.g., iTerm on macOS, Git Bash on Windows).

Getting Started 🚀

1. Requirements

   • git version >= 2.40

2. Install the Extension:

   • Download from the Visual Studio Marketplace or Open VSX Registry.
   • Or search for "Git Worktree Manager" in VSCode’s Extensions view and install.

3. Quick Start:

   • Open VSCode in a Git repository.
   • Press Ctrl+Shift+R to launch the worktree manager.
   • Create, switch, or delete worktrees using the intuitive interface.

4. Example Workflow:

   • Create a new worktree: Select “Create Worktree” and specify a branch.
   • Switch to it instantly via the Source Control view or command palette.
   • Add it to your VSCode workspace to work on multiple branches side by side.
   • Save it to favorites for quick access in the future.

Configuration ⚙️

Customize Git Worktree Manager to fit your workflow:

• git-worktree-manager.treeView.toSCM
  Display worktrees in the Source Control view.

• git-worktree-manager.treeView.worktreeDescriptionTemplate
  Customize the description next to each worktree in the tree view. Handy for spotting stale worktrees at a glance.
  Available variables: $FULL_PATH, $BASE_NAME, $RELATIVE_PATH, $LAST_COMMIT (relative time of the last commit, e.g. "3 weeks ago"). Hover a worktree to see the absolute timestamp.
  Example:"$RELATIVE_PATH · $LAST_COMMIT"

• git-worktree-manager.treeView.worktreeLabelTemplate
  Customize the label (the bold text) of each worktree in the tree view. Leave empty to keep the default label (the branch or tag name).
  Available variables: $REF_NAME (branch or tag name), $BASE_NAME, $FULL_PATH, $RELATIVE_PATH, $LAST_COMMIT.
  Example:"$BASE_NAME ⇄ $REF_NAME" shows the worktree folder name first, then the branch.

• git-worktree-manager.worktreeCopyPatterns
  Specify files or directories to be copied into a newly created worktree
  (for example, local config files or environment-specific assets).
  Example:[".env.local", "config/*.json"]

• git-worktree-manager.worktreeCopyIgnores
  Exclude specific files or paths from being copied when creating a worktree,
  even if they match worktreeCopyPatterns.
  Example:["node_modules/**", "dist/**"]

• git-worktree-manager.postCreateCmd
  Run a command automatically after a worktree is created
  (for example, installing dependencies or running setup scripts).
  Example:"pnpm install" or "echo 'Worktree ready'"

• git-worktree-manager.preRemoveCmd
  Run a command automatically before a worktree is removed
  (for example, tearing down side effects such as a per-worktree database
  schema or stopping services).
  Runs inside the worktree directory. If the command fails or is cancelled,
  the removal is aborted.
  Example:"pnpm run worktree:teardown-db"

• terminal.external.windowsExec
  Set the external terminal on Windows
  (e.g. "C:\\Program Files\\Git\\bin\\bash.exe" for Git Bash).

• terminal.external.osxExec
  Set the external terminal on macOS
  (e.g. "iTerm.app").

Contributing 🤝

We love contributions! Here’s how to get involved:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/awesome-idea).
3. Commit your changes (git commit -m "Add awesome idea").
4. Push to the branch (git push origin feature/awesome-idea).
5. Open a Pull Request.

Have ideas? Open an issue with the "enhancement" tag or explore open issues.

License 📜

Distributed under the MIT License. Use, modify, and share freely!