Uplink Docs
Installation

Installation

Install the latest stable CLI release:

curl -fsSL https://uplink.computer/install.sh | sh

Set UPLINK_VERSION=v0.1.0 to install a specific release tag, or UPLINK_INSTALL_DIR=/path/to/bin to choose the destination.

Or download the archive for your platform from the GitHub Releases page, then install both CLI-side binaries into the same directory on your PATH:

tar -xzf uplink-v0.1.0-<platform>.tar.gz
sudo install -m 0755 uplink-v0.1.0-<platform>/uplink \
  uplink-v0.1.0-<platform>/uplink-agent \
  /usr/local/bin

The CLI binary is uplink. uplink-agent is the local serving daemon the CLI starts automatically for background serving and status commands.

To build from this workspace instead:

cargo build --workspace
./tools/install.sh

The operator-side edge binary is uplink-edge.

Desktop app

The macOS desktop client lives in desktop/ and hosts the shared React/TypeScript UI from web-ui/.

pnpm install --frozen-lockfile
pnpm -C desktop tauri dev

The desktop app and the CLI both call the shared uplink-core crate, so they manage the same local state, tunnels, request inspector, and login profile.

Requirements

Uplink is built from this repo with Rust and pnpm. A managed private route needs a login/control plane. A self-hosted key-mode edge can serve public, password, firewall, WAF, rate-limit, and IP/token policy routes without hosted identity.