Binboi

Binboi docs

Documentation center

Product docs for tunnels, tokens, webhooks, logs, and the self-hosted control plane.

Getting Started

Introduction Quick Start Installation Authentication

Using Binboi

CLI HTTP Tunnels Requests

Debugging

Webhooks API Keys Logs

Operations

Regions Troubleshooting

Quick path

Install the CLI, create a dashboard token, and open a public URL for `localhost` in minutes.

binboi login --token <token>
binboi start 3000 my-app

Installation

Choose the install path that matches how your team works.

Binboi is designed to be comfortable as a packaged CLI and straightforward to build from source. This guide covers Homebrew, npm wrapper direction, direct release binaries, and local contributor setup.

Install overview Homebrew npm direction Direct binary Contributor setup

Overview

Installation paths at a glance

Most users should prefer a packaged binary, while contributors or operators often build from source.

RecommendedPreferred

Homebrew

The cleanest macOS developer install path once your release artifacts are published.

DirectionPlanned

npm global wrapper

A convenient future path for JavaScript-heavy teams, especially when they already use npm-based developer tooling.

ManualSupported

Direct release binary

Download the correct `tar.gz` for your OS and architecture and place `binboi` on your PATH.

ContributorsAvailable

Build from source

Ideal when you are modifying the relay, CLI, or dashboard locally and want complete control over the build.

Packages

Install with Homebrew

Homebrew is the most polished install story for macOS users once release binaries are published.

Homebrew install

bash

brew install binboi/tap/binboi
binboi version

The repository now includes release-friendly artifact naming, a sample Homebrew formula, and a stable `binboi version` command for formula testing. That makes the Homebrew path a realistic distribution target rather than placeholder packaging.

JavaScript teams

npm global install direction

The npm wrapper is part of the product direction, especially for teams that live inside Node-based developer tooling.

Planned npm flow

bash

npm install -g @binboi/cli
binboi version

Treat this as packaging direction unless your published package already exists. The current repo focuses on a solid Go CLI first.

Why document it now?

Because teams evaluating the product often ask how the CLI will be distributed in real life. The docs should answer that honestly even before every packaging channel is fully live.

Manual install

Direct binary installation

Direct binary install is the simplest cross-platform path when you are distributing internal builds or testing release candidates.

Direct binary install

bash

tar -xzf binboi_0.4.0_darwin_arm64.tar.gz
sudo mv binboi /usr/local/bin/binboi
binboi version

Release artifact naming follows the pattern `binboi_<version>_<os>_<arch>.tar.gz`.

That convention keeps Homebrew, direct downloads, and CI packaging aligned around one predictable artifact layout.

Local development

Contributor setup

If you are changing code in the relay or dashboard, build everything locally and run the pieces side by side.

Contributor install flow

bash

git clone https://github.com/sardorazimov/binboi.git
cd binboi
go build -o binboi-server ./cmd/binboi-server
go build -o binboi ./cmd/binboi-client
cd web
npm install
npm run dev

Local contributor rule of thumb

Build the server and CLI directly from source when you are changing tunnel lifecycle, auth, or dashboard behavior. That keeps your debugging loop close to the real codepath.