Skip to content

Commit 90f14a3

Browse files
authored
Update README.md
1 parent 0ac017e commit 90f14a3

1 file changed

Lines changed: 46 additions & 11 deletions

File tree

README.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,53 @@
11
Git Worktree Extension for Visual Studio
2-
A lightweight Visual Studio extension to manage Git worktrees easily. Create, switch, and work on multiple branches simultaneously without leaving your IDE.
32

4-
Features
5-
Create new worktrees for branches
3+
A lightweight extension to easily manage Git worktrees inside Visual Studio. Create, switch, and work on multiple branches without leaving your IDE.
64

7-
Switch between worktrees effortlessly
5+
What it does:
86

9-
Manage multiple branches side-by-side
7+
* Create new worktrees for any branch
8+
* Switch between worktrees smoothly
9+
* Manage multiple branches side-by-side
1010

11-
Why?
12-
Visual Studio’s Git integration lacks smooth multi-branch workflows. This tool fixes that.
11+
Why? Visual Studio’s Git support doesn’t handle multi-branch workflows well. This fixes that.
1312

14-
Installation
15-
Install from the Visual Studio Marketplace or build from source.
13+
How to install:
14+
Get it from the Visual Studio Marketplace or build from source.
1615

17-
Usage
18-
Open the extension, create or switch worktrees, and keep your workflow clean.
16+
Usage:
17+
After installation, two options appear under **Git > Git Worktree**:
18+
![image](https://github.com/user-attachments/assets/158b87d3-b6a0-4137-bb1d-0c15831db435)
19+
20+
21+
* **Create Worktree** (Ctrl+Shift+=)
22+
* **Manage Worktrees** (Ctrl+Shift+)
23+
24+
**Create Worktree Window:**
25+
![image](https://github.com/user-attachments/assets/105abd78-32bb-456d-9024-58c2152766d4)
26+
27+
1. Shows current repo
28+
2. Choose branch from a list (branches with a "+" prefix are active worktrees)
29+
3. Set path for new worktree
30+
4. Force create option (overwrites overlapping worktrees)
31+
5. Option to open the new worktree in a new Visual Studio window (works if “Load” is enabled in settings)
32+
6. Creates new Worktree for selected branch in selected path
33+
34+
**Manage Worktrees Window:**
35+
![image](https://github.com/user-attachments/assets/178b9b63-61c3-47e8-a2b7-72f80a3372cb)
36+
37+
1. Shows current repo
38+
2. List of all created worktrees
39+
3. Option to open the selected worktree in a new Visual Studio window
40+
4. Open selected worktree
41+
5. Force remove (even if uncommitted changes exist)
42+
6. Prune dangling worktree references
43+
7. Remove selected worktree
44+
45+
**Settings:**
46+
![image](https://github.com/user-attachments/assets/008a34af-1337-4fef-ab34-b91d54249867)
47+
48+
Accessible via **Git > Settings > Source Control > Git Worktree**
49+
50+
* **Default branch path:** If empty, defaults to `repo path\<repo>_worktree\<branch>`, else user-defined path
51+
* **Load:** If enabled, opens new worktree in a new window after creation (enables the checkbox in create window)
52+
53+
This keeps your multi-branch Git workflow smooth and integrated, right inside Visual Studio.

0 commit comments

Comments
 (0)