Skip to content

Repository files navigation

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

Create a personal API token in the fortrabbit dashboard, then store it in your operating-system credential store:

frbit auth login

Interactive login prints the token creation URL and tries to open it in your default browser. Use frbit auth login --no-browser to keep the flow entirely in the terminal.

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 deployments logs dp-a1b2c3
frbit auth status

The CLI can also install and manage fortrabbit agent skills. 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 build
just test

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 used for the token creation link during interactive login.

Host resolution is: --host, FRBIT_HOST, saved host, then the production default.

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.

License

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

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

About

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

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages