Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

On a Mac with Apple silicon, or on 64-bit Intel or ARM Linux, this installs the latest release:

curl -fsSL https://raw.githubusercontent.com/uji-labs/uji/main/install.sh | sh
VariableEffect
UJI_INSTALL_DIRThe folder uji goes in, instead of ~/.local/bin.
UJI_VERSIONA release such as v0.3.0 instead of the latest one.

The Linux builds need glibc 2.34 or newer. On Alpine, other musl systems and older releases such as Ubuntu 20.04, build uji with Cargo.

With Homebrew

brew install uji-labs/uji/uji

Homebrew installs the same ready-made build as the script. brew upgrade uji moves to a newer release.

On Fedora with COPR

sudo dnf copr enable @uji-labs/Uji
sudo dnf install uji

With Nix

nix profile add github:uji-labs/uji

With home-manager, add the flakes of uji and its plugins to your inputs:

inputs = {
  uji.url = "github:uji-labs/uji";
  uji-plugins.url = "github:uji-labs/uji-plugins";
};

Then import their modules and turn uji on:

{ inputs, ... }:
{
  imports = [
    inputs.uji.homeModules.default
    inputs.uji-plugins.homeModules.default
  ];

  programs.uji.enable = true;
}

programs.uji.plugins.<name>.enable turns a plugin on or off.

With Cargo

cargo install --git https://github.com/uji-labs/uji --locked uji

The build needs Rust 1.88 or newer, a C compiler and make. Cargo puts the uji binary in ~/.cargo/bin, and uji --version prints the version once your shell finds it.

From a clone of the repository, run cargo install --path crates/uji --locked in its top folder instead. Adding --force to either command replaces an installed uji with a newer one.