Burrowee Docs

Appearance

Install the CLI ​

Install the CLI on the machine you connect from — your laptop or workstation. It is the client side of every Burrowee tunnel: SSH, local port-forwarding, and session management.

sh
curl -fsSL --proto '=https' --tlsv1.2 https://release.burrowee.com/cli/install.sh | sh

The installer detects your OS and architecture, downloads the latest cli release, verifies it (minisign signature, then SHA-256 — see the install overview for the full chain), and installs three binaries into $PREFIX/bin (default ~/.local/bin):

  • burrowee — the universal dispatcher. The CLI is its fallthrough default, so burrowee connect … just works.
  • burrowee-cli — the client itself: bootstrap, connect, ssh, daemon, relays, gateways, login, update, doctor, …
  • burrowee-cli-updater — a small helper burrowee cli update hands off to when applying an update to itself.

If ~/.local/bin is not on your PATH, the installer says so and prints the line to add:

sh
export PATH="$HOME/.local/bin:$PATH"

First run ​

On a fresh interactive install (a real terminal, not CI), the installer offers to set the CLI up on the spot:

Set up now? Paste the setup blob + PIN from the console (Enter to skip).
blob>

Paste the pairing blob minted at your gateway's local console (the cloud console cannot mint CLI pairings — see CLI bootstrap), then the PIN, and the installer runs burrowee cli bootstrap for you. Press Enter to skip — you can always do it later:

sh
burrowee cli bootstrap <blob> <pin>

Two cases where the prompt does not appear:

  • Already set up — if ~/.burrowee/cli/ exists with state in it, re-installing never re-prompts; the binaries are simply updated in place.
  • No terminal (CI, a detached script) — the installer just prints the bootstrap command as your next step.

Platform notes ​

  • macOS: every release is verified via minisign + SHA-256 before install (see the install overview); the binaries themselves are ad-hoc signed, not Developer ID signed or notarized, but since they arrive via curl | sh rather than a browser download, macOS never sets the quarantine attribute in the first place — the installer strips it defensively anyway. If you ever place a binary on PATH by hand and macOS blocks it: xattr -d com.apple.quarantine ~/.local/bin/burrowee-cli.
  • Linux: a preflight step tries to install minisign, unzip, and curl for you via your package manager (root if available); if that's not possible, install them yourself (apt-get install minisign unzip or your distro's equivalent) — verification is mandatory and the installer aborts without them. Skip preflight with BURROWEE_SKIP_PREFLIGHT=1.

Next step ​

Pair the CLI with your account and gateway: CLI bootstrap.