rsworktree 0.6.4

CLI helper for managing Git worktrees under a dedicated .rsworktree directory
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

# rsworktree

[![Codecov](https://codecov.io/gh/ozankasikci/rust-git-worktree/branch/master/graph/badge.svg)](https://codecov.io/gh/ozankasikci/rust-git-worktree)

`rsworktree` is a Rust CLI for managing Git worktrees in a single repo-local directory (`.rsworktree`). It provides a focused, ergonomic workflow for creating, jumping into, listing, and removing worktrees without leaving the terminal.

## Table of Contents

- [Interactive mode](#interactive-mode)
- [CLI commands](#cli-commands)
  - [`rsworktree create`](#rsworktree-create)
  - [`rsworktree cd`](#rsworktree-cd)
  - [`rsworktree ls`](#rsworktree-ls)
  - [`rsworktree rm`](#rsworktree-rm)
  - [`rsworktree pr-github`](#rsworktree-pr-github)
  - [`rsworktree merge-pr-github`](#rsworktree-merge-pr-github)
- [Installation](#installation)
- [Environment](#environment)

## Interactive mode

- Open a terminal UI for browsing worktrees, focusing actions, and inspecting details without memorizing subcommands.
- Launch it with the `interactive` command: `rsworktree interactive` (shortcut: `rsworktree i`).
- Available actions include opening worktrees, removing them, creating PRs, and merging PRs without leaving the TUI.
- The merge flow lets you decide whether to keep the local branch, delete the remote branch, and clean up the worktree before exiting.
- ![Interactive mode screenshot](tapes/gifs/interactive-mode.gif)

## CLI commands

### `rsworktree create`

- Create a new worktree under `.rsworktree/<name>`. Also changes directory to the worktree.
- Demo: ![Create demo](tapes/gifs/create.gif)
- Options:
  - `--base <branch>` — branch from `<branch>` instead of the current git branch.

### `rsworktree cd`

- Spawn an interactive shell rooted in the named worktree.
- Demo: ![CD demo](tapes/gifs/cd.gif)
- Options:
  - `--print` — write the worktree path to stdout without spawning a shell.

### `rsworktree ls`

- List all worktrees tracked under `.rsworktree`, showing nested worktree paths.
- Demo: ![List demo](tapes/gifs/ls.gif)
- Options:
  - _(none)_

### `rsworktree rm`

- Remove the named worktree.
- Demo: ![Remove demo](tapes/gifs/rm.gif)
- Options:
  - `--force` — force removal, mirroring `git worktree remove --force`.

### `rsworktree pr-github`

- Push the worktree branch and invoke `gh pr create` for the current or named worktree.
- Demo: ![PR demo](tapes/gifs/pr_github.gif)
- Requires the [GitHub CLI](https://cli.github.com/) (`gh`) to be installed and on your `PATH`.
- Options:
  - `<name>` — optional explicit worktree to operate on; defaults to the current directory.
  - `--remove` — delete the remote branch after a successful merge.
  - `--no-push` — skip pushing the branch before creating the PR.
  - `--draft` — open the PR in draft mode.
  - `--fill` — let `gh pr create` auto-populate PR metadata.
  - `--web` — open the PR creation flow in a browser instead of filling via CLI.
  - `--reviewer <login>` — add one or more reviewers by GitHub login.
  - `-- <extra gh args>` — pass additional arguments through to `gh pr create`.

### `rsworktree merge-pr-github`

- Merge the open GitHub pull request for the current or named worktree using `gh pr merge`.
- Demo: ![Merge PR demo](tapes/gifs/merge_pr_github.gif)
- Requires the [GitHub CLI](https://cli.github.com/) (`gh`) to be installed and on your `PATH`.
- Options:
  - `<name>` — optional explicit worktree to operate on; defaults to the current directory.

## Installation

Install from crates.io with:

```bash
cargo install rsworktree
```

On macOS you can install via Homebrew:

```bash
brew tap ozankasikci/tap
brew install rsworktree
```

After the binary is on your `PATH`, run `rsworktree --help` to explore the available commands.

## Environment

Set `RSWORKTREE_SHELL` to override the shell used by `rsworktree cd` (falls back to `$SHELL` or `/bin/sh`).