frbit CLI

frbit is the command-line interface for the fortrabbit public API.

For installation, authentication, automation, and the complete command reference, see the installation guide and CLI documentation.

Install

curl -fsSL https://github.com/fortrabbit/frbit-cli/releases/latest/download/install.sh | sh

You can also install with Homebrew, npm, or a GitHub release archive. See the installation guide for every supported method.

Authenticate

Sign in through the browser and store the credential in your operating-system credential store:

frbit auth login

The command prints the sign-in URL and a code, opens the URL in your default browser, and waits up to 15 minutes. Type the code on the consent page. Without an account, the same page signs you up. Use --no-browser to only print the URL, and --json for machine-readable output: {"url": …, "confirmation_code": …, "status": "waiting"} at once, then {"status": "signed_in", "next": …}. The credential refreshes itself; frbit auth status shows its expiry and the next setup step.

--signup opens the sign-up page, for people without an account. --name "<name>" suggests the name for the new account (1 to 100 characters).

In CI or without a browser, store a personal API token from standard input:

printf '%s' "$TOKEN" | frbit auth login --token-stdin

Or supply it for one command or an automated job:

FRBIT_TOKEN=frbit-at-… frbit apps list

FRBIT_TOKEN takes precedence over the stored credential.

Usage

frbit apps list
frbit apps list --page 2
frbit apps list --json
frbit environments list
frbit environments variables get en-a1b2c3
frbit environments restart en-a1b2c3
frbit environments deploy en-a1b2c3
frbit deployments logs dp-a1b2c3
frbit auth status

The CLI can also set up fortrabbit for coding agents. See the CLI documentation for details.

Just recipes

just is an optional command runner. The run recipe forwards arguments to the CLI without keeping a binary in the working directory:

just run apps list
just run apps list --json
FRBIT_TOKEN=frbit-at-… just run apps list

Other available recipes:

just                            # list the available recipes
just build
just symlink                    # build, then link ./frbit into /usr/local/bin
just test

Uninstall

One command removes the agent setup, the Claude Code plugin, the sign-in, the config and cache folders and the binary. It lists everything and asks first:

frbit uninstall

A Homebrew or npm install is removed through brew or npm. On Windows the running binary cannot delete itself; the command names the file to delete. Other profiles than the selected one: frbit auth logout --profile <name> first. To keep the CLI and only undo frbit setup agent, run frbit setup agent --remove.

Development

Development and release builds use Go 1.26.6. A compatible Go installation will automatically download the declared toolchain when GOTOOLCHAIN is left at its default auto setting.

go test ./...
go run ./cmd/frbit apps list
just run apps list

To build a reusable binary in the repository root and run it directly:

just build
./frbit

Target a development API

The default API host is https://api.fortrabbit.com. For a single command, use the root --host option or FRBIT_HOST:

FRBIT_TOKEN=frbit-at-… \
  just run --host http://localhost:8085 apps list

FRBIT_HOST=http://localhost:8085 \
  FRBIT_TOKEN=frbit-at-… \
  just run apps list

To persist a host and token in your local CLI configuration and operating-system keychain, log in against that host:

FRBIT_DASHBOARD_URL=http://localhost:3001 \
  just run --host http://localhost:8085 auth login

FRBIT_DASHBOARD_URL controls the dashboard origin for the page shown after the browser sign-in and for the token creation link.

Host resolution is: --host, FRBIT_HOST, saved host, then the production default. The CLI warns before it sends credentials to a non-default host; only use an override you trust.

Release

just release --dry-run          # preview the next minor release
just release                    # default: increase the minor version
just release --patch
just release --major

CI validates formatting, static analysis, tests, builds, and the GoReleaser configuration. Pushing a v* tag creates the GitHub release archives, checksums, SBOMs, Homebrew formula, and npm packages. The release job runs in the review-gated release environment and publishes a GitHub build-provenance attestation for checksums.txt. When the GitHub CLI (gh) is installed, the installer verifies that attestation before installing. To require this check, set FRBIT_VERIFY_PROVENANCE=1; otherwise the installer warns and continues when gh is unavailable.

License

This project is licensed under the MIT License. See LICENSE.

Licenses for software included in release binaries are collected in THIRD_PARTY_NOTICES.