@burstflare/flare

flare is the command-line interface for BurstFlare.

It gives you direct access to the BurstFlare control plane for:

• authentication
• workspace settings and billing
• instance CRUD, rebuilds, and common-state sync
• session lifecycle and runtime access
• snapshots, reports, exports, and reconcile operations

Install

Global install:

npm install -g @burstflare/flare

The npm install now checks for the OpenSSH tools used by flare ssh and warns if ssh or ssh-keygen is missing.

You can re-check your machine any time with:

flare doctor

One-off use with npx:

npx @burstflare/flare help

The installed command is:

flare

Quick Start

The CLI talks to https://burstflare.dev by default.

Register:

flare auth register --email [email protected]

Create an instance:

flare instance create node-dev --image node:20

Launch a session and attach:

flare session up sandbox --instance <instanceId>
flare ssh <sessionId>

flare ssh wakes sleeping sessions if needed, provisions a per-session SSH key in your local flare config directory, syncs the public key to the session, and opens the tunnel and SSH session directly. Add --print to inspect the tunnel endpoint and local attach details.

Common Commands

flare auth whoami
flare help session
flare help instance
flare doctor
flare workspace
flare instance list
flare instance inspect <instanceId>
flare sessions
flare snapshot list <sessionId>
flare report

flare help <topic> and --help now show focused help for command groups and individual commands, while the default flare output stays grouped by command area.

Config

The CLI stores its local config at:

~/.config/flare/config.json

You can override that path with:

FLARE_CONFIG=/path/to/config.json

Notes

• Use --url only when you want to target a non-default environment, such as local development.
• For local development, the dashboard runs at http://127.0.0.1:8787.

License

Licensed under Apache-2.0. See LICENSE.