Installation and setup¶

Installation¶

Download pre-built binaries for a release¶

There arepre-built binaries of the last released version ofjj forWindows, Mac, or Linux (the "musl" version should work on all distributions).

Cargo Binstall¶

If you usecargo-binstall, youcan install binaries of the latestjj release from GitHub as follows:

# Will put the jj binary for the latest release in ~/.cargo/bin by defaultcargobinstall--strategiescrate-meta-datajj-cli

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

Linux¶

From Source¶

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

sudoapt-getinstallbuild-essential

Now run either:

# To install the *prerelease* version from the main branchcargoinstall--githttps://github.com/jj-vcs/jj.git--locked--binjjjj-cli

or:

# To install the latest releasecargoinstall--locked--binjjjj-cli

Arch Linux¶

You can install thejujutsu package from theofficial extra repository:

pacman-Sjujutsu

Or install from theAUR repository with anAUR Helper:

yay-Sjujutsu-git

NixOS¶

If you're on NixOS you can install areleased version ofjj using thenixpkgsjujutsu package.

To install aprerelease version, you can use the flake for this repository.For example, if you want to runjj loaded from the flake, use:

nixrun'github:jj-vcs/jj'

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

# Installs the prerelease version from the main branchnixprofileinstall'github:jj-vcs/jj'

Homebrew¶

If you use Homebrew, you can run:

# Installs the latest releasebrewinstalljj

Gentoo Linux¶

dev-vcs/jj is available in theGURU repository.Details on how to enable the GURU repository can be foundhere.

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

emerge-avdev-vcs/jj

openSUSE Tumbleweed¶

jujutsu can be installed from the officialopenSUSE-Tumbleweed-Oss repository:

zypperinstalljujutsu

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 branchcargoinstall--githttps://github.com/jj-vcs/jj.git\--locked--binjjjj-cli

or:

# To install the latest releasecargoinstall--locked--binjjjj-cli

Homebrew¶

If you use Homebrew, you can run:

# Installs the latest releasebrewinstalljj

MacPorts¶

You can also installjj viathe MacPortsjujutsuport:

# Installs the latest releasesudoportinstalljujutsu

Windows¶

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

# To install the *prerelease* version from the main branchcargoinstall--githttps://github.com/jj-vcs/jj.git--locked--binjjjj-cli

or:

# To install the latest releasecargoinstall--locked--binjjjj-cli

via winget:

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

via scoop:

# To install the latest release via scoopscoopinstallmain/jj

Initial configuration¶

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

$jjconfigset--useruser.name"Martin von Zweigbergk"$jjconfigset--useruser.email"martinvonz@google.com"

Command-line completion¶

Jujutsu provides 2 different command-line completion scripts.

Standard completions¶

The standard completion script provides completions forjj subcommands andoptions.

Dynamic completions¶

The dynamic completion script provides completions forjj subcommands andoptions, as well as additional completions, including bookmarks,aliases, revisions, operations and files. Dynamic completions can be contextaware, 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 engineis still labeled unstable. We expect to transition to them as thedefault once the engine is stabilized. Please let us know if you encounter anyissues with dynamic completions.

Bash¶

source<(jjutilcompletionbash)

source<(COMPLETE=bashjj)

Zsh¶

autoload-Ucompinitcompinitsource<(jjutilcompletionzsh)

source<(COMPLETE=zshjj)

Fish¶

jjutilcompletionfish|source

COMPLETE=fishjj|source

Nushell¶

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

Xonsh¶

source-bash$(jjutilcompletion)

Powershell¶

jjutilcompletionpower-shell|Out-String|Invoke-Expression

$env:COMPLETE="powershell"jj|Out-String|Invoke-ExpressionRemove-ItemEnv:\COMPLETE

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