Documentation
Everything you need to get bx running and connected.
Installation
macOS / Linux
curl -sSL install.blax-cat.com | sh
Windows (PowerShell)
iwr install.blax-cat.com/install.ps1 | iex
Manual download
Download from install.blax-cat.com or GitHub releases.
| File | Platform |
|---|---|
| bx-darwin-arm64 | macOS — Apple Silicon |
| bx-darwin-amd64 | macOS — Intel |
| bx-linux-amd64 | Linux — x86_64 |
| bx-linux-arm64 | Linux — ARM64 |
| bx-windows-amd64.exe | Windows (coming soon) |
Sign in
Login is required to access sessions from the web or mobile client. Local tabs work without an account.
bx login email: you@example.com sending code… enter 6-digit code: 482917 logged in as you@example.com
A 6-digit OTP is sent to your email via Resend. No password required. Rate limited to 10 requests per hour.
bx whoami # show signed-in email bx logout # remove credentials
Quick start
# Start a session (auto-spawns the daemon) bx # List running sessions bx list # Reconnect to a session bx attach blax-1 # Detach: press Ctrl+C # Kill all sessions bx kill-all
bx login only when you need web/mobile access.Commands
| Command | Description |
|---|---|
| bx / new [name] | Start a new session. Auto-names if no name given. |
| bx list | List active sessions. Aliases: ls, tabs |
| bx attach <name|id> | Reconnect to an existing session. |
| bx session | Show info about the current session (from inside). |
| bx rename <name|id> <new> | Rename a session. Alias: mv |
| bx kill <name|id> | Terminate a session. |
| bx kill-all | Terminate all sessions. |
| bx login | Sign in with email OTP. |
| bx logout | Remove stored credentials. |
| bx whoami | Show signed-in email. |
| bx update | Download and install the latest version. |
| bx uninstall | Remove bx binary and all data from this machine. |
| bx doctor | Diagnose common issues. |
| bx version | Print version. |
Web client
Open app.blax-cat.com, sign in with your email, and your sessions appear automatically.
Mobile app
iOS and Android apps are in development. Use the web client from your mobile browser for now.
Uninstall
bx uninstall
Stops the daemon, removes all config/state directories, and deletes the binary. If you get a permission error on the binary removal, run with sudo:
sudo bx uninstall
What gets removed:
| Path | Contents |
|---|---|
| ~/.config/bx/ | Config file and credentials |
| ~/.local/state/bx/ | Daemon log |
| ~/.local/share/bx/ | Unix socket |
| /usr/local/bin/bx | Binary |
End-to-end encryption
All terminal data is encrypted before leaving your machine.
Key exchange: X25519 ECDH (ephemeral keypair per connection) Key derivation: HKDF-SHA256 → 32-byte AES key Encryption: AES-256-GCM (random 12-byte nonce per frame) bx daemon ──[ciphertext only]──▶ relay ──▶ client
How it works
Your terminal
└── bx daemon ──── encrypted tunnel ────▶ relay
│
▼
Web / Mobile client
Daemon
Auto-spawned on first bx run. Keeps sessions alive after terminal close.
| Path | Purpose |
|---|---|
| $XDG_RUNTIME_DIR/bx/sock | Unix socket (IPC) |
| ~/.local/share/bx/sock | Fallback socket |
| ~/.local/state/bx/daemon.log | Daemon logs |
| ~/.config/bx/credentials | Auth credentials (0600) |
bx daemon # start manually for debugging