Roboflare
Getting started

Install the CLI

Build the beacon CLI from source and sign in via the browser.

beacon is the Beacon command-line client. It talks to the same API the dashboard uses, so anything you do in the UI you can script.

Build from source

git clone https://github.com/upsurge/roboflare.git
cd roboflare/cli
cargo build --release
sudo cp target/release/beacon /usr/local/bin/beacon

Verify the install:

beacon --version

Sign in

beacon login

This opens your browser to https://roboflare.pages.dev/cli/authorize, where you sign in with Clerk and pick the organization to authorize. The CLI listens on an ephemeral 127.0.0.1 port for the one-time authorization code, exchanges it for a token, and writes credentials to ~/.config/roboflare/credentials.toml.

For headless environments (CI, remote shells), skip the browser:

beacon login --token rf_user_<paste-here>
# or
BEACON_TOKEN=rf_user_... beacon login

By default the CLI points at https://beacon-api.canlearn.workers.dev. Override per command with --base-url, or pass --base-url to beacon login to persist a different backend.

Tokens grant full org access at the role they were issued for. Treat them like SSH keys — never commit them, never paste them into shared Slack channels.

Log out

beacon logout

This removes the local credentials file. Tokens themselves are not revoked server-side; revoke at the dashboard or with POST /api/org-users/{id}/revoke.

Next

You have a working CLI but no robots. Continue to Enroll a robot.

On this page