https://github.com/ozankasikci/rust-git-worktree

A cli application written in rust in order make working with git worktrees easier.
https://github.com/ozankasikci/rust-git-worktree

cli git git-worktree rust terminal worktree

Last synced: 4 months ago
JSON representation

A cli application written in rust in order make working with git worktrees easier.

• Host: GitHub
• URL: https://github.com/ozankasikci/rust-git-worktree
• Owner: ozankasikci
• License: mit
• Created: 2025-09-25T22:37:01.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2025-10-05T01:14:56.000Z (4 months ago)
• Last Synced: 2025-10-05T03:32:14.919Z (4 months ago)
• Topics: cli, git, git-worktree, rust, terminal, worktree
• Language: Rust
• Homepage:
• Size: 1.5 MB
• Stars: 19
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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/`. Also changes directory to the worktree.

- Demo: ![Create demo](tapes/gifs/create.gif)

- Options:

  - `--base ` — branch from `` 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:

  - `` — 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 ` — add one or more reviewers by GitHub login.

  - `-- ` — 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:

  - `` — 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`).