How to use the command git worktree (with examples)

The git worktree command is used to manage multiple working trees attached to the same repository. It allows users to work on different branches simultaneously without needing to switch branches in the main working tree. Each working tree has its own set of local files and can be used to make isolated changes.

Use case 1: Create a new directory with the specified branch checked out into it

Code:

git worktree add path/to/directory branch

Motivation: This use case is helpful when you need to work on a specific branch in a separate directory. It allows you to have two working trees for the same repository, each pointing to a different branch. This can be useful for parallel development or testing new features without affecting the main working tree.

Explanation:

• git worktree add: Command to add a new working tree.
• path/to/directory: The path to the directory where the new working tree will be created.
• branch: The name of the branch to check out into the new working tree.

Example output:

Preparing worktree (new branch 'feature-branch')
HEAD is now at a1b2c3d Commit message

Use case 2: Create a new directory with a new branch checked out into it

Code:

git worktree add path/to/directory -b new_branch

Motivation: This use case is useful when you want to create a new branch and work on it in a separate directory. It allows you to have a dedicated working tree for the newly created branch, enabling efficient development and testing.

Explanation:

• git worktree add: Command to add a new working tree.
• path/to/directory: The path to the directory where the new working tree will be created.
• -b new_branch: The -b option is used to create a new branch with the given name and check it out into the new working tree.

Example output:

Preparing worktree (detached HEAD)
HEAD is now at a1b2c3d Commit message

Use case 3: List all the working directories attached to this repository

Code:

git worktree list

Motivation: When working with multiple working trees, it becomes important to keep track of all the directories attached to the repository. The git worktree list command provides an overview of all the attached working directories with their corresponding branches.

Explanation:

• git worktree list: Command to list all the working directories attached to the repository.

Example output:

path/to/directory  a1b2c3d [master]
path/to/another/directory  c3d4e5f [feature-branch]

Use case 4: Remove a worktree (after deleting worktree directory)

Code:

git worktree prune

Motivation: Sometimes, you might want to remove a previously created working tree that is no longer needed. The git worktree prune command is used to clean up the list of working trees by removing any entries that no longer exist on disk.

Explanation:

• git worktree prune: Command to remove worktree entries that no longer exist on disk.

Example output:

Pruning stale working trees...

Removed worktree path/to/directory