Binboi Docs/Getting Started/Quick Start

Quick Start

Get a local port exposed at https://<your-subdomain>.binboi.com in four steps.

1. Create an account

Sign up at binboi.com and verify your email. The verification link arrives from noreply@binboi.com. New accounts start on the Free plan.

2. Generate an access token

Open binboi.com/dashboard/access-tokens and click Generate Token. The token is shown once in a modal with a Copy button — copy it now and store it somewhere safe (a password manager is fine). It cannot be retrieved later.

Token format: binboi_pat_<8 hex>_<36 hex> (56 chars total). The Free plan allows up to 2 active tokens. If you hit the cap, revoke an existing token or upgrade.

3. Install the CLI

Pick your platform — see Installation for full options.

code
# npm (coming soon)
npm install -g @binboi/cli
 
# Homebrew (coming soon)
brew install miransas/tap/binboi

While public distribution is being prepared, contact contact@miransas.com for early access to the CLI binary.

4. Log in and open a tunnel

code
binboi login --token binboi_pat_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
binboi http 3000

Your local service on port 3000 is now reachable at a randomly assigned URL — the CLI prints it on startup:

Forwarding https://wispy-otter-7421.binboi.com → http://localhost:3000

Pro and Max users can request a specific subdomain by passing it positionally:

code
binboi http 3000 my-app

Press Ctrl+C to stop the tunnel.

Next