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

Install

kanri is a single static-ish binary, no runtime beyond what’s listed per method below. Pick your OS.

Status: the AUR package and apt repository below are packaging templates in this repo (packaging/aur/, packaging/debian/) — not live yet, pending the first tagged release. Building from source (Nix flake or plain cargo) works today.

Arch Linux

yay -S kanri

(Coming soon — not yet published to the AUR. Until then, build from source below, or use the PKGBUILD directly:)

git clone https://git.kanri.management/jaghack/kanri.git
cd kanri/packaging/aur
makepkg -si

Ubuntu / Debian

curl -fsSL https://kanri.management/apt/key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/kanri.gpg
echo "deb [signed-by=/usr/share/keyrings/kanri.gpg] https://kanri.management/apt stable main" | sudo tee /etc/apt/sources.list.d/kanri.list
sudo apt update && sudo apt install kanri

(Coming soon — the apt repository isn’t hosted yet. Build a .deb locally in the meantime: see packaging/debian/README.md in the repo.)

NixOS (flake)

{
  inputs.kanri.url = "git+https://git.kanri.management/jaghack/kanri.git";

  outputs = { self, nixpkgs, kanri, ... }: {
    nixosConfigurations.yourhost = nixpkgs.lib.nixosSystem {
      # ...
      modules = [
        {
          environment.systemPackages = [ kanri.packages.x86_64-linux.default ];
        }
      ];
    };
  };
}

Or try it without installing anything:

nix run git+https://git.kanri.management/jaghack/kanri.git

Build from source (any distro, works today)

Needs a Rust toolchain (edition 2024, so a reasonably recent one) and libclang (one dependency’s build script needs it for bindgen).

git clone https://git.kanri.management/jaghack/kanri.git
cd kanri
cargo build --release
./target/release/kanri

Or with Nix, no system Rust install needed:

nix develop   # or: nix-shell
cargo run

After installing

kanri works with zero config. Some features need one-time, deliberate setup you do yourself (kanri never grants privilege on its own) — see wireguard.md for WireGuard status/control and capture.md for packet capture. Everything else (network devices, processes, memory, disk, hardware, Tailscale) works out of the box.

See config.md for configuration and keybindings.md for the full keybinding reference.