Binboi Docs/Getting Started/Quick Start

Quick Start

Get your first public HTTPS URL in under two minutes.

Prerequisites

A Binboi account — sign up at binboi.com
Node.js 18+, Homebrew, or a direct binary download

Step 1 — Install the CLI

Choose the method that matches your platform:

code

# npm (all platforms)
npm install -g @miransas/binboi
 
# Homebrew (macOS / Linux)
brew install miransas/tap/binboi
 
# Direct binary (Linux / macOS)
curl -fsSL https://binboi.com/install.sh | sh

Verify the install:

code

binboi --version
# binboi 1.0.0

Step 2 — Log In

Generate a Personal Access Token at binboi.com/dashboard/access-tokens, then authenticate:

code

binboi login --token binboi_pat_xxx_yyy

The token is saved to ~/.binboi/config.json and reused automatically for every subsequent command.

Confirm it worked:

code

binboi whoami
# Logged in as you@example.com (FREE plan)

Step 3 — Expose Port 3000

Start your local dev server (e.g. npm run dev), then open a tunnel to it:

code

binboi http 3000

You will see output like this:

code

Tunnel started
  Public URL : https://abc123.binboi.com
  Forwarding : https://abc123.binboi.com → http://localhost:3000
  Status     : online
  Region     : eu-fra

Press Ctrl+C to stop

Open https://abc123.binboi.com in any browser or share it with a teammate — requests are forwarded live to your local machine.

What's Next?

Keep the tunnel alive with a reserved subdomain so the URL never changes between sessions (Pro+):
code
```
binboi http 3000 --subdomain myapp
# https://myapp.binboi.com
```
Inspect every request in real time at http://localhost:4040 (the local dashboard).
Use binboi tcp 5432 to expose a database or other TCP service.
Integrate tunnels directly in code with the JavaScript SDK, Python SDK, or Rust SDK.