Installation

Prerequisites

Before installing jj-spr, you need to have Jujutsu (jj) installed on your system. See the Jujutsu installation guide for instructions.

Installation Methods

From Source (Recommended)

jj-spr is written in Rust. You need a Rust toolchain to build from source. See rustup.rs for information on how to install Rust if you don’t have it already.

Using cargo install (easiest):

git clone https://github.com/LucioFranco/jj-spr.git
cd jj-spr
cargo install --path spr

This will install the jj-spr binary to your ~/.cargo/bin directory.

Verify Installation

After installation, verify that jj-spr is available:

jj-spr --version

Next Steps

After installation, you’ll need to:

1. Set up the Jujutsu alias to use jj-spr as a subcommand:

   jj config set --user aliases.spr '["util", "exec", "--", "jj-spr"]'
   

2. Initialize in your repository:

   cd your-jujutsu-repo
   jj spr init
   

See the Setup Guide for detailed configuration instructions.