multitree 0.1.0

A small CLI tool to manage Git worktrees
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

# multitree

A CLI tool for managing Git worktrees with sensible defaults and configurable behavior.

`multitree` wraps common `git worktree` workflows to make adding, listing, removing, and cleaning worktrees a bit more convenient — without abstracting away Git itself.

---

## Features

- Add worktrees (creates branch automatically if needed)
- List existing worktrees
- Open a shell inside a worktree
- Remove worktrees (optional confirmation)
- Clean orphaned worktrees
- Configurable base branch and path resolution
- Optional merge checks and remote pruning before cleanup

---

## Usage

### Add a worktree

```bash
multitree add feature-x
```

If the branch does not exist, it will be created from the configured base branch.

Optional custom path:

```bash
multitree add feature-x --path ../worktrees
```

---

### List worktrees

```bash
multitree list
```

---

### Track (enter) a worktree

```bash
multitree track feature-x
```

This spawns a shell inside the selected worktree.

---

### Remove a worktree

```bash
multitree remove feature-x
```

If confirmation is enabled in config, you will be prompted before removal.

---

### Clean orphaned worktrees

```bash
multitree clean
```

Force cleanup without confirmation:

```bash
multitree clean --force
```

Cleanup respects configuration settings such as:
- Auto-fetch and prune before checking
- Skipping unmerged branches
- Optional deletion of local branches

---

## Configuration

Config file location:

- Linux: `~/.config/multitree/Config.toml`
- macOS: `~/Library/Application Support/multitree/Config.toml`
- Windows: `%APPDATA%\multitree\Config.toml`

Example configuration:

```toml
default_base_branch = "main"

[path]
resolution = "repo_parent" # repo_parent | repo_root | custom
custom_base = ""

[clean]
auto_fetch = true
require_merged = true
delete_local_branch = false

[ui]
preferred_shell = ""
confirm_before_remove = true
```

---

## Path Resolution Modes

| Mode         | Description |
|--------------|-------------|
| repo_parent  | Create worktrees next to the repository |
| repo_root    | Create worktrees inside the repository root |
| custom       | Use a custom base directory |

---

## Testing

`multitree` uses integration tests with real temporary Git repositories to verify behavior for:

- Worktree creation
- Listing
- Removal
- Cleanup logic
- Confirmation handling

Run:

```bash
cargo test
```

---

## License

MIT