Installation

Keyit ships as two binaries: keyit for developers and keyit-relay for teams who want to run their own relay. There is no account to create before you initialize a project.

Homebrew (macOS or Linux)

brew tap simplbase/tap
brew install keyit

If you do not want to tap first:

brew install simplbase/tap/keyit

Homebrew installs both keyit and keyit-relay. Most developers only run keyit. The relay binary is there for people who would rather own the server than use ours.

Ubuntu and other Linux distributions

User-local install:

curl -fsSL https://raw.githubusercontent.com/simplbase/keyit/main/packaging/install-release.sh | sh

This downloads the latest GitHub Release, checks it against SHA256SUMS, and installs:

$HOME/.local/bin/keyit
$HOME/.local/bin/keyit-relay

Make sure $HOME/.local/bin is on PATH.

System-wide install:

curl -fsSL https://raw.githubusercontent.com/simplbase/keyit/main/packaging/install-release.sh | sudo env PREFIX=/usr/local sh

This installs to /usr/local/bin instead.

Custom prefix:

curl -fsSL https://raw.githubusercontent.com/simplbase/keyit/main/packaging/install-release.sh | PREFIX=/usr/local sh

Pin a specific version:

curl -fsSL https://raw.githubusercontent.com/simplbase/keyit/main/packaging/install-release.sh | KEYIT_VERSION=v1.0.0 sh

What the installer does

The installer downloads the matching GitHub Release archive, verifies it against SHA256SUMS, and installs keyit plus keyit-relay. It does not edit your shell config and it does not initialize a project.

Released targets

The public release artifacts currently cover:

aarch64-apple-darwin
x86_64-apple-darwin
x86_64-unknown-linux-gnu
x86_64-pc-windows-msvc

That means macOS on Apple Silicon, macOS on Intel, Ubuntu and other glibc-based x86_64 Linux distributions, and Windows. Linux ARM is not published yet.

Windows

Download the Windows ZIP from the GitHub Release page, verify it against SHA256SUMS, and put keyit.exe somewhere on PATH. The archive also includes keyit-relay.exe.

Install from source

Use this when you are working from a checkout:

PREFIX="$HOME/.local" ./packaging/install.sh

This builds the workspace with the locked dependency graph and installs $PREFIX/bin/keyit and $PREFIX/bin/keyit-relay.

Verify it's on PATH

keyit version

Shell completions

keyit completions zsh > ~/.zsh/completions/_keyit
keyit-relay completions zsh > ~/.zsh/completions/_keyit-relay

Supported shell names come from Clap: bash, zsh, fish, powershell, elvish.

Installed and on PATH? Move on to Quickstart for the fake loop, or First Project before you point Keyit at a real repository.

Running your own relay is a separate decision. It is not required for install, init, or the local demo.