Installation and setup - Jujutsu docs

Skip to content

# Installation and setup

## Installation

### Download pre-built binaries for a release

There are pre-built binaries of the last released version of `jj` for Windows, Mac, or Linux (the "musl" version should work on all distributions).

#### Cargo Binstall

If you use `cargo-binstall`, you can install binaries of the latest `jj` release from GitHub as follows:

    # Will put the jj binary for the latest release in ~/.cargo/bin by default
    cargo binstall --strategies crate-meta-data jj-cli

Without the `--strategies` option, you may get equivalent binaries that should be compiled from the same source code.

Note

If you'd like to install a prerelease version, you'll need to use one of the options below.

### Linux

#### From Source

First make sure that you have a Rust version >= 1.88 and that the `build-essential` package is installed by running something like this:

    sudo apt-get install build-essential

Now run either:

    # To install the *prerelease* version from the main branch
    cargo install --git https://github.com/jj-vcs/jj.git --locked --bin jj jj-cli

or:

    # To install the latest release
    cargo install --locked --bin jj jj-cli

#### Arch Linux

You can install the `jujutsu` package from the official extra repository:

    pacman -S jujutsu

Or install from the AUR repository with an AUR Helper:

    yay -S jujutsu-git

#### NixOS

If you're on NixOS you can install a released version of `jj` using the nixpkgs `jujutsu` package.

To install a prerelease version, you can use the flake for this repository. For example, if you want to run `jj` loaded from the flake, use:

    nix run 'github:jj-vcs/jj'

You can also add this flake url to your system input flakes. Or you can install the flake to your user profile:

    # Installs the prerelease version from the main branch
    nix profile install 'github:jj-vcs/jj'

#### Homebrew

If you use Homebrew, you can run:

    # Installs the latest release
    brew install jj

#### Gentoo Linux

`dev-vcs/jj` is available in the GURU repository. Details on how to enable the GURU repository can be found here.

Once you have synced the GURU repository, you can install `dev-vcs/jj` via Portage:

    emerge -av dev-vcs/jj

#### openSUSE Tumbleweed

`jujutsu` can be installed from the official openSUSE-Tumbleweed-Oss repository:

    zypper install jujutsu

### Mac

#### From Source

First make sure that you have a Rust version >= 1.88. You may also need to run:

    xcode-select --install

Now run either:

    # To install the *prerelease* version from the main branch
    cargo install --git https://github.com/jj-vcs/jj.git \
         --locked --bin jj jj-cli

or:

    # To install the latest release
    cargo install --locked --bin jj jj-cli

#### Homebrew

If you use Homebrew, you can run:

    # Installs the latest release
    brew install jj

#### MacPorts

You can also install `jj` via the MacPorts `jujutsu` port:

    # Installs the latest release
    sudo port install jujutsu

### Windows

First make sure that you have a Rust version >= 1.88. Now run either:

    # To install the *prerelease* version from the main branch
    cargo install --git https://github.com/jj-vcs/jj.git --locked --bin jj jj-cli

or:

    # To install the latest release
    cargo install --locked --bin jj jj-cli

via winget:

    # To install the latest release via winget
    winget install jj-vcs.jj

via scoop:

    # To install the latest release via scoop
    scoop install main/jj

### FreeBSD

`devel/jujutsu` is available in the ports.

Install pre-built pkg:

    # To install the latest release via pkg
    pkg install jujutsu

Install from building the port:

    # To install the latest release via ports
    cd /usr/ports/devel/jujutsu/ && make install clean

## Runtime Requirements

You will need git 2.41.0 or above. On older systems (e.g. Debian 11, Ubuntu 22.04) you will need to upgrade Git.

## Initial configuration

You may want to configure your name and email so commits are made in your name.

    $ jj config set --user user.name "Martin von Zweigbergk"
    $ jj config set --user user.email "martinvonz@google.com"

## Command-line completion

Jujutsu provides 2 different command-line completion scripts.

### Standard completions

The standard completion script provides completions for `jj` subcommands and options.

### Dynamic completions

The dynamic completion script provides completions for `jj` subcommands and options, as well as additional completions, including bookmarks, aliases, revisions, operations and files. Dynamic completions can be context aware, for example they respect the global flags `--repository` and `--at-operation` as well as some command-specific ones like `--revision`, `--from`, and `--to`.

Dynamic completions are not the default/only option since the underlying engine is still labeled unstable. We expect to transition to them as the default once the engine is stabilized. Please let us know if you encounter any issues with dynamic completions.

Which completion script should I use?

Generally, dynamic completions provide a much better completion experience. Although the underlying engine is deemed unstable, there have not been many issues in practice. Dynamic completions are the preferred option for many contributors and users.

We recommend using the dynamic completion script, and falling back to the standard completion script if there are any issues.

### Bash

Standard Dynamic

    source <(jj util completion bash)

    source <(COMPLETE=bash jj)

### Zsh

Standard Dynamic

    autoload -U compinit
    compinit
    source <(jj util completion zsh)

    source <(COMPLETE=zsh jj)

### Fish

Standard Dynamic

    jj util completion fish | source

Note

No configuration is required with fish >= 4.0.2 which loads dynamic completions by default.

    COMPLETE=fish jj | source

### Nushell

Standard

    jj util completion nushell | save -f completions-jj.nu
    use completions-jj.nu *  # Or `source completions-jj.nu`

### Powershell

Standard Dynamic

    jj util completion power-shell | Out-String | Invoke-Expression

    $env:COMPLETE = "powershell"
    jj | Out-String | Invoke-Expression
    Remove-Item Env:\COMPLETE

Insert the above into your `$PROFILE` file (usually `$HOME\Documents\PowerShell\Microsoft.PowerShell_profile.ps1`).

Note

Note that to execute scripts in PowerShell on Windows, including `$PROFILE`, the execution policy needs to be set to `RemoteSigned` at minimum.