Installation
Install the Binboi CLI on your machine. The CLI is a single static binary with no runtime dependencies.
System Requirements
| Requirement | Minimum | |---|---| | OS | macOS 12+, Linux (glibc 2.17+), Windows 10+ | | Architecture | x86_64, arm64 | | Disk | ~15 MB |
macOS
Homebrew (recommended)
brew install binboi/tap/binboiDirect download
# Apple Silicon (M1/M2/M3)
curl -fsSL https://dl.binboi.dev/latest/darwin-arm64/binboi -o /usr/local/bin/binboi
chmod +x /usr/local/bin/binboi
# Intel
curl -fsSL https://dl.binboi.dev/latest/darwin-amd64/binboi -o /usr/local/bin/binboi
chmod +x /usr/local/bin/binboiSee the macOS guide for Gatekeeper and PATH notes.
Linux
Install script (recommended)
curl -fsSL https://dl.binboi.dev/install.sh | shThe script detects your architecture, downloads the correct binary to /usr/local/bin/binboi, and sets execute permissions.
Manual download
# x86_64
curl -fsSL https://dl.binboi.dev/latest/linux-amd64/binboi -o /usr/local/bin/binboi
chmod +x /usr/local/bin/binboi
# arm64
curl -fsSL https://dl.binboi.dev/latest/linux-arm64/binboi -o /usr/local/bin/binboi
chmod +x /usr/local/bin/binboiAPT (Debian / Ubuntu)
echo "deb [trusted=yes] https://apt.binboi.dev stable main" \
| sudo tee /etc/apt/sources.list.d/binboi.list
sudo apt update && sudo apt install binboiSee the Linux guide for systemd service setup.
Windows
WinGet
winget install Binboi.CLIScoop
scoop bucket add binboi https://github.com/binboi/scoop-bucket
scoop install binboiManual installer
Download binboi-windows-amd64.exe from the releases page, rename it to binboi.exe, and place it somewhere on your PATH (e.g. C:\Program Files\Binboi\).
npm (all platforms)
If you already have Node.js 18+, you can install the CLI wrapper via npm:
npm install -g @binboi/cliThis downloads the correct platform binary and wires up the binboi command automatically.
Verify the Installation
binboi --version
# binboi 1.0.0
binboi --helpUpgrading
# Homebrew
brew upgrade binboi
# npm
npm update -g @binboi/cli
# Install script (re-run)
curl -fsSL https://dl.binboi.dev/install.sh | shNext Steps
- Quick Start — open your first tunnel
- Authentication — log in to your Binboi server
