worktrees.nvim

A simple and configurable Neovim plugin for working with Git worktrees.

worktrees.nvim makes it easy to create, delete, and switch between Git worktrees directly from Neovim. When switching between worktrees, it will try to open the same file in the target worktree if it exists.

Note

This project is feature complete for its intended small scope of managing Git worktrees (create, delete, switch). While actively maintained, new features will be limited to improvements of existing functionality and simple additions within this scope. Pull requests are welcome as long as they align with these goals.

Demo

worktrees.nvim.demo.mov

Features

• Create new Git worktrees with branch creation
• Delete worktrees with confirmation
• Switch between worktrees while preserving your place in files
• Customizable commands and keymaps
• Works with any Git worktree structure

Requirements

• Neovim 0.11.0 or higher
• Git installed and accessible in path
• A Git repository

Installation

Setup with lazy.nvim

{
   "afonsofrancof/worktrees.nvim",
   event = "VeryLazy",
   opts = {
          -- Specify where to create worktrees relative to git common dir
          -- The common dir is the .git dir in a normal repo or the root dir of a bare repo
          base_path = "..",  -- Parent directory of common dir
          
          -- Template for worktree folder names
          -- This is only used if you don't specify the folder name when creating the worktree
          path_template = "{branch}",  -- Default: use branch name
          
          -- Command names (optional)
          commands = {
            create = "WorktreeCreate",
            delete = "WorktreeDelete",
            switch = "WorktreeSwitch",
          },
          
          -- Key mappings for interactive UI (optional)
          mappings = {
            create = "<leader>wtc",
            delete = "<leader>wtd",
            switch = "<leader>wts",
          }
    }
}

Configuration Options

Option	Description	Default
base_path	Path relative to git common directory where worktrees will be created	".." (parent directory)
path_template	Template for worktree folder names, {branch} is replaced with branch name	"{branch}"
commands.create	Command name for creating worktrees	"WorktreeCreate"
commands.delete	Command name for deleting worktrees	"WorktreeDelete"
commands.switch	Command name for switching worktrees	"WorktreeSwitch"
mappings.create	Key mapping for creating worktrees	nil (not set)
mappings.delete	Key mapping for deleting worktrees	nil (not set)
mappings.switch	Key mapping for switching worktrees	nil (not set)

Common Worktree Configurations

Worktrees in parent directory (standard)

require('worktrees').setup({
  base_path = ".."  -- worktrees at the parent directory of the .git directory
})

Worktrees inside the repository

require('worktrees').setup({
  base_path = "."  -- worktrees inside same directory as .git
})

Worktrees outside the repository

require('worktrees').setup({
  base_path = "../.."  -- worktrees outside the repo 
})

Usage

Commands (Interactive UI)

Command	Description
:WorktreeCreate	Interactively create a new worktree
:WorktreeDelete	Delete a worktree with an interactive selector
:WorktreeSwitch	Switch to another worktree with an interactive selector

Functions (Interactive UI)

-- Create a worktree interactively
require('worktrees').create()

-- Switch to a worktree interactively
require('worktrees').switch()

-- Delete a worktree interactively
require('worktrees').delete()

Functions (API)

-- Create a new worktree
---@param path string path to the new worktree
---@param branch string name of the branch to use in the new worktree
---@param switch? boolean should the plugin switch to the newly created worktree
---@return string|nil # path of the new worktree if it was created successfully
require('worktrees').utils.create_worktree("path/to/worktree", "feature-branch", true)

-- Switch to a worktree by path
---@param path string path to the worktree
---@return boolean # Indicates if the switch was successfull
require('worktrees').utils.switch_worktree("path/to/worktree")

-- Delete a worktree by path
---@param path string path to the worktree
---@return boolean # Indicates if the deletion was successfull
require('worktrees').utils.delete_worktree("path/to/worktree")

How It Works

1. Create: When creating a worktree, you'll be prompted for a branch name and an optional path. The path is relative to the base_path specified in your config.

2. Delete: Shows a selection menu of available worktrees. After selecting one, you'll be asked to confirm deletion.

3. Switch: Shows a selection menu of other worktrees. After selecting one, the plugin will:

   • If the current file exists in the target worktree: Switch to that file
   • Otherwise: Change to the worktree directory and open the startup buffer

License

MIT