Jujutsu

https://docs.jj-vcs.dev/latest/
Admin
Jujutsu is a Git-compatible version control system that provides a modern approach to source code...
Tokens:184,655
Snippets:1,924
Trust Score:7.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### One-time development environment setup

Source: https://docs.jj-vcs.dev/latest/contributing

Commands to install the required Rust toolchains and development binaries for the project.

```bash
rustup toolchain add nightly  # wanted for 'rustfmt'
rustup toolchain add 1.89     # also specified in Cargo.toml
cargo install --locked bacon
cargo install --locked cargo-insta
cargo install --locked cargo-nextest
```

--------------------------------

### Install uv on Windows

Source: https://docs.jj-vcs.dev/latest/contributing

Installs uv using PowerShell.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

--------------------------------

### Revset fork_point() function examples

Source: https://docs.jj-vcs.dev/latest/revsets

Examples demonstrating the fork_point() function.

```text
fork_point(E|D) ⇒ {B}
fork_point(E|C) ⇒ {A}
fork_point(E|B) ⇒ {B}
fork_point(E|A) ⇒ {A}
fork_point(D|C) ⇒ {C}
fork_point(D|B) ⇒ {B}
fork_point(B|C) ⇒ {A}
fork_point(A) ⇒ {A}
fork_point(none()) ⇒ {}
```

--------------------------------

### Revset roots() function examples

Source: https://docs.jj-vcs.dev/latest/revsets

Examples demonstrating the roots() function.

```text
roots(E|D) ⇒ {E,D}
roots(E|C) ⇒ {E,C}
roots(E|B) ⇒ {B}
roots(E|A) ⇒ {A}
roots(A) ⇒ {A}
```

--------------------------------

### Revset heads() function examples

Source: https://docs.jj-vcs.dev/latest/revsets

Examples demonstrating the heads() function.

```text
heads(E|D) ⇒ {E,D}
heads(E|C) ⇒ {E,C}
heads(E|B) ⇒ {E}
heads(E|A) ⇒ {E}
heads(A) ⇒ {A}
```

--------------------------------

### Platform condition examples

Source: https://docs.jj-vcs.dev/latest/config

Examples of matching platforms using --when.platforms.

```toml
--when.platforms = ["windows"]            # matches only Windows
--when.platforms = ["linux", "freebsd"]   # matches Linux *OR* FreeBSD, but *NOT* macOS
--when.platforms = ["unix"]               # matches anything in the Unix family (Linux, FreeBSD, macOS, etc.)
```

--------------------------------

### Hostname condition examples

Source: https://docs.jj-vcs.dev/latest/config

Examples of matching hostnames using --when.hostnames.

```toml
--when.hostnames = ["work-laptop"]               # matches only "work-laptop"
--when.hostnames = ["home-desktop", "laptop"]    # matches "home-desktop" *OR* "laptop"
```

--------------------------------

### Revset connected() function examples

Source: https://docs.jj-vcs.dev/latest/revsets

Examples demonstrating the connected() function.

```text
connected(E|A) ⇒ {E,B,A}
connected(D|A) ⇒ {D,C,B,A}
connected(A) ⇒ {A}
```

--------------------------------

### Install uv on macOS/Linux

Source: https://docs.jj-vcs.dev/latest/contributing

Installs the uv Python project manager.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

--------------------------------

### Command condition examples

Source: https://docs.jj-vcs.dev/latest/config

Examples of matching subcommands using --when.commands.

```toml
--when.commands = ["file"]        # matches `jj file show`, `jj file list`, etc
--when.commands = ["file show"]   # matches `jj file show` but *NOT* `jj file list`
--when.commands = ["file", "log"] # matches `jj file` *OR* `jj log` (*OR* subcommand of either)
```

--------------------------------

### Install uv via Homebrew

Source: https://docs.jj-vcs.dev/latest/contributing

Installs uv using the Homebrew package manager.

```bash
brew install uv
```

--------------------------------

### Environment variable condition examples

Source: https://docs.jj-vcs.dev/latest/config

Examples of matching environment variables using --when.environments.

```toml
--when.environments = ["CI=true"]                     # matches when CI is set to "true"
--when.environments = ["CI"]                          # matches when CI is set to anything
--when.environments = ["CI=true", "CI=1"]             # matches when CI is "true" *OR* "1"
--when.environments = ["CI=true", "GITHUB_ACTIONS=1"] # matches when *EITHER* condition holds
```

--------------------------------

### Example CLI Commands for Sparse Patterns

Source: https://docs.jj-vcs.dev/latest/design/sparse-v2

Provides examples of CLI commands for setting sparse patterns, including shorthand notations. The editor and CLI will accept rules in either format.

```plaintext
jj sparse set --add foo/bar
jj sparse set --add include:dir:foo/bar
jj sparse set --add exclude:dir:foo/bar
jj sparse set --exclude foo/bar

```

--------------------------------

### Operator binding power examples

Source: https://docs.jj-vcs.dev/latest/templates

Examples of operator precedence and grouping using parentheses.

```text
x ++ y * z
```

```text
x * y / z
```

```text
(x + y) * z
```

--------------------------------

### Example Rule Set and Inclusion Logic

Source: https://docs.jj-vcs.dev/latest/design/sparse-v2

Demonstrates an example rule set and how file inclusion is determined by the first matching rule in reverse order. This illustrates the behavior of the new ordered pattern structure.

```plaintext
include:dir:foo
exclude:dir:foo/bar
include:dir:foo/bar/baz
exclude:dir:foo/bar/baz/qux

```

--------------------------------

### Install JJ Prerelease Version with Nix Profile

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the prerelease version of JJ from its main branch into the user's Nix profile.

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

--------------------------------

### Install uv via Cargo

Source: https://docs.jj-vcs.dev/latest/contributing

Install the uv package manager using the Rust cargo tool.

```bash
cargo install --git https://github.com/astral-sh/uv uv
```

--------------------------------

### Parent calculation example with P's parent as A

Source: https://docs.jj-vcs.dev/latest/design/jj-converge-command

Example of parent calculation when P's parent is A, showing how it resolves to {A}.

```text
parents = P⁻ + (B/0⁻ - P⁻) + (B/1⁻ - P⁻)
        = {X} + ({A} - {X}) + ({A} - {X})
        = {A} + ({A} - {X})

```

--------------------------------

### Start SSH with port forwarding for diffedit3-ssh

Source: https://docs.jj-vcs.dev/latest/config

Use this command to manually start an SSH session with the necessary port forwarding for diffedit3-ssh.

```bash
ssh -L 17376:localhost:17376 \
    -L 17377:localhost:17377 \
    -L 17378:localhost:17378 \
    -L 17379:localhost:17379 \
    -L 17380:localhost:17380 \
    myhost.example.com
```

--------------------------------

### Install Latest JJ Release from Ports on FreeBSD

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the latest stable release of JJ on FreeBSD by building the port from source.

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

--------------------------------

### Install Prerelease JJ from Source with Cargo

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the prerelease version of JJ from its main branch using Cargo. Requires Rust >= 1.88.

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

--------------------------------

### List type all method

Source: https://docs.jj-vcs.dev/latest/templates

Example of using the all method to verify a condition across all parents.

```text
parents.all(|c| c.mine())
```

--------------------------------

### Get configuration value with TOML key

Source: https://docs.jj-vcs.dev/latest/changelog

Example of using the 'jj config get' command to retrieve a specific configuration value using a TOML key.

```bash
jj config get "revset-aliases.'trunk()'"
```

--------------------------------

### Start Local Documentation Server

Source: https://docs.jj-vcs.dev/latest/contributing

Run the documentation server locally to preview changes in real-time.

```bash
uv run mkdocs serve
```

--------------------------------

### Example Workflow with Managed Config

Source: https://docs.jj-vcs.dev/latest/design/managed-config

Illustrates a workflow involving checking out branches from origin, which may have different managed configurations.

```bash
jj new main@origin
jj ...
jj new stable-branch@origin
```

--------------------------------

### Materialized Conflict Markers in Jujutsu

Source: https://docs.jj-vcs.dev/latest/conflicts

This example illustrates how Jujutsu represents a conflict in a file using specific markers. It shows the start and end of the conflict, the diff from the merge base, and the changes from two different commits.

```text
<<<<<<< conflict 1 of 1
%%%%%%% diff from: vpxusssl 38d49363 "merge base"
\\\		 to: rtsqusxu 2768b0b9 "commit A"
 apple
-grape
+grapefruit
 orange
+++++++ ysrnknol 7a20f389 "commit B"
APPLE
GRAPE
ORANGE
>>>>>>> conflict 1 of 1 ends

```

--------------------------------

### Prepare repository for publishing

Source: https://docs.jj-vcs.dev/latest/releasing

Commands to clone the repository into a temporary directory and checkout the specific version tag for publishing.

```bash
cd $(mktemp -d)
jj git clone https://github.com/jj-vcs/jj
cd jj
jj new v0.<number>.0
```

--------------------------------

### Install uv on macOS/Linux without modifying PATH

Source: https://docs.jj-vcs.dev/latest/contributing

Installs uv while preventing the installer from modifying the shell profile.

```bash
curl -LsSf https://astral.sh/uv/install.sh | env INSTALLER_NO_MODIFY_PATH=1 sh
```

--------------------------------

### Configure clang-format for C and H files

Source: https://docs.jj-vcs.dev/latest/config

Example configuration to format C and header files using clang-format, including sorting of include directives.

```toml
[fix.tools.clang-format]
command = ["/usr/bin/clang-format", "--sort-includes", "--assume-filename=$path"]
patterns = ["glob:'**/*.c'",
            "glob:'**/*.h'"]
```

--------------------------------

### Deploy Specific Version Documentation

Source: https://docs.jj-vcs.dev/latest/contributing

Switch to a specific version tag and deploy it as the latest release.

```bash
jj new v1.33.1  # Let's say `jj 1.33.1` is the latest release
.github/scripts/docs-build-deploy v1.33.1 latest --push
```

--------------------------------

### Example of Initial File Content

Source: https://docs.jj-vcs.dev/latest/conflicts

This shows the original content of a file before any conflicting changes are made.

```text
apple
grape
orange


```

--------------------------------

### Set up RAM disk on macOS

Source: https://docs.jj-vcs.dev/latest/contributing

Commands to create and mount a RAM disk to improve test performance on macOS.

```bash
sudo mkdir -p /Volumes/RAMDisk
sudo chmod a+wx /Volumes/RAMDisk
sudo mount_tmpfs /Volumes/RAMDisk  # Add `-e` to make it case-sensitive
                      # Add `-o nobrowse` to hide the tmpfs from Finder
```

--------------------------------

### Commit Graph Example

Source: https://docs.jj-vcs.dev/latest/revsets

The example commit graph used for illustrating revset operator behavior.

```text
D
|\
B C
|/
A
|
root()
```

--------------------------------

### Enter Nix development shell

Source: https://docs.jj-vcs.dev/latest/contributing

Activates the Nix development environment.

```bash
nix develop
```

--------------------------------

### Install Jujutsu on openSUSE Tumbleweed

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the 'jujutsu' package on openSUSE Tumbleweed from the official Oss repository.

```bash
zypper install jujutsu
```

--------------------------------

### jj util completion zsh setup

Source: https://docs.jj-vcs.dev/latest/cli-reference

Commands to initialize and load the Zsh completion script for jj.

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

--------------------------------

### Install Jujutsu on Arch Linux

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the 'jujutsu' package on Arch Linux from the official extra repository.

```bash
pacman -S jujutsu
```

--------------------------------

### Internalize filters examples

Source: https://docs.jj-vcs.dev/latest/technical/revset-evaluation

Examples showing the transformation of revset expressions to group filters at the end of an intersection.

```text
(::y | empty()) & ::x => ::x & filter(::y | empty())
conflicts() & ::x & empty() => ::x & filter(conflicts() & empty())
```

--------------------------------

### Programmatic snapshotting example

Source: https://docs.jj-vcs.dev/latest/cli-reference

Demonstrates how changes to a file are captured in an operation log after running a script that executes jj commands.

```bash
$ echo content > new-file.txt
# At this point, `jj` does not know about `new-file.txt`.
$ ./my-script-that-runs-jj-commands
# Since the script ran `jj` commands, the changes to `new-file.txt` have
# been snapshotted in an operation, which you can see with:
$ jj operation log --patch
```

--------------------------------

### Sort negations and ancestors examples

Source: https://docs.jj-vcs.dev/latest/technical/revset-evaluation

Examples of sorting elements in an intersection based on negation and ancestor categories.

```text
~w & x & ~::y & ::z => ~::y & ::z & x & ~w
::w & ~::x & ::y & ~::z => ~::x & ~::z & ::w & ::y
```

--------------------------------

### Configure tools using workspace-relative paths

Source: https://docs.jj-vcs.dev/latest/config

Example configuration for a tool located within the workspace using the $root variable.

```toml
[fix.tools.biome]
command = ["$root/node_modules/@biomejs/biome/bin/biome", "format", "--stdin-file-path=$path"]
patterns = ["glob:'**/*.ts'", "glob:'**/*.tsx'"]
```

--------------------------------

### Fold generations optimization examples

Source: https://docs.jj-vcs.dev/latest/technical/revset-evaluation

Examples of how the fold generations pass optimizes specific revset patterns.

```text
x-- => ancestors(x, 2..3)
::(x-) => ancestors(x, 1..MAX)
(::x)- => ancestors(x, 1..MAX)
ancestors(x---, 5) => ancestors(x, 3..8)
```

--------------------------------

### Install Build Tools on Linux

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the 'build-essential' package required for compiling from source on Debian-based Linux systems.

```bash
sudo apt-get install build-essential
```

--------------------------------

### Deploy Prerelease Documentation

Source: https://docs.jj-vcs.dev/latest/contributing

Build and deploy the current commit as the prerelease version of the documentation.

```bash
.github/scripts/docs-build-deploy prerelease main --push
```

--------------------------------

### Install Jujutsu on Gentoo Linux

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the 'dev-vcs/jj' package on Gentoo Linux via Portage after enabling the GURU repository.

```bash
emerge -av dev-vcs/jj
```

--------------------------------

### Define custom merge tool configurations

Source: https://docs.jj-vcs.dev/latest/config

Examples of out-of-the-box configurations for kdiff3, meld, and vimdiff, demonstrating how to set merge-args and program paths.

```toml
[merge-tools.kdiff3]
# program  = "kdiff3"     # Defaults to the name of the tool if not specified
merge-args = ["$base", "$left", "$right", "-o", "$output", "--auto"]
[merge-tools.meld]
merge-args = ["$left", "$base", "$right", "-o", "$output", "--auto-merge"]

[merge-tools.vimdiff]
merge-args = ["-f", "-d", "$output", "-M",
    "$left", "$base", "$right",
    "-c", "wincmd J", "-c", "set modifiable",
    "-c", "set write"]
program = "vim"
merge-tool-edits-conflict-markers = true    # See below for an explanation
```

--------------------------------

### Install Jujutsu from AUR on Arch Linux

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the 'jujutsu-git' package from the AUR repository on Arch Linux using an AUR helper.

```bash
yay -S jujutsu-git
```

--------------------------------

### Initialize an empty Git-backed Jujutsu repo

Source: https://docs.jj-vcs.dev/latest/git-compatibility

Use this command to create a new Jujutsu repository that uses a regular Git repository for storage. This results in both a .jj and a .git directory in the same location.

```bash
jj git init <name>
```

--------------------------------

### Install Latest JJ Release with Cargo

Source: https://docs.jj-vcs.dev/latest/install-and-setup

Installs the latest stable release of JJ using Cargo. Requires Rust >= 1.88.

```bash
# To install the latest release
car go install --locked --bin jj jj-cli
```
Tokens:
Raw