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 | shThe 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 two binaries into $PREFIX/bin (default ~/.local/bin):
burrowee— the universal dispatcher. The CLI is its fallthrough default, soburrowee connect …just works.burrowee-cli— the client itself:bootstrap,connect,ssh,daemon,relays.
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 setup blob from the console, 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
bootstrapcommand as your next step.
Platform notes
- macOS: the installer removes the Gatekeeper quarantine attribute automatically. If you ever place a binary on
PATHby hand and macOS blocks it:xattr -d com.apple.quarantine ~/.local/bin/burrowee-cli. - Linux: make sure
minisignandunzipare installed (apt-get install minisign unzipor your distro's equivalent) — verification is mandatory and the installer aborts without them.
Next step
Pair the CLI with your account and gateway: CLI bootstrap.