Cookies ahead

Our support chat tool "Intercom" would like to collect some more data on you. See the related link for more details.

Docs

CLI

⌨️

Keep both hands on the keyboard.

Use the fortrabbit CLI to manage apps, environments and deployments from a terminal, a script or a CI job.

The CLI is a single binary named frbit and runs on most operating systems. It is a client of the public API and it authenticates with your personal API token.

Use cases

  • A person works from a terminal
  • A script runs unattended
  • A CI pipeline
  • Sets up MCP server and the skills: frbit setup agent

See intro to agentic workflows for more details on which tool to use when.

Scope

  • Deploying, restarting and reading deployment logs from a terminal or a CI job
  • Reading and setting environment variables without opening the dashboard
  • Listing apps, environments, domains and teams, with --json for scripts
  • Creating an app or a staging environment from a set of component plans
  • Wiring the MCP server and the agent skills into a coding agent

The source code, the release archives, and the full command reference live in the

Install

The install script is the shortest path on macOS and Linux. Homebrew and npm suit machines that already manage tooling that way. The release archives cover everything else, Windows included.

Install script

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

It detects operating system and CPU architecture, downloads the matching GitHub release, verifies its SHA-256 checksum and installs frbit in ~/.local/bin. When run as root, it uses /usr/local/bin instead. The script prints a reminder when the install directory is not on PATH.

Install a specific release or choose another destination by passing an environment variable to sh:

curl -fsSL https://github.com/fortrabbit/frbit-cli/releases/latest/download/install.sh | FRBIT_VERSION=1.0.0 sh
curl -fsSL https://github.com/fortrabbit/frbit-cli/releases/latest/download/install.sh | FRBIT_INSTALL_DIR="$HOME/bin" sh
shell

Homebrew

The fortrabbit tap provides a binary formula for macOS and Linux:

brew install fortrabbit/tap/frbit
shell

Upgrade an existing installation with brew upgrade frbit. Homebrew verifies the SHA-256 checksum generated for each release.

npm

The npm package installs the native binary for the current platform as an optional dependency:

npm install --global @fortrabbit/cli
shell

Do not install with --omit=optional; the wrapper needs its platform package.

GitHub releases

Archives, checksums and software bills of materials are available on the GitHub releases page. The stable asset names work with generic binary installers such as eget, ubi and mise.

PlatformAsset
macOS Apple siliconfrbit_macOS_AppleSilicon.tar.gz
macOS Intelfrbit_macOS_Intel.tar.gz
Linux arm64frbit_linux_arm64.tar.gz
Linux x86-64frbit_linux_amd64.tar.gz
Windows arm64frbit_windows_arm64.zip
Windows x86-64frbit_windows_amd64.zip

Confirm the installation with frbit version.

Authenticate

The CLI signs in once and keeps the token in the operating-system credential store. Automated jobs skip that and pass the token per command instead. Create a personal API token under API tokens in the account menu of the dashboard, then run:

frbit auth login
shell

The command prints the token creation URL and tries to open it in the default browser — frbit auth login --no-browser keeps the flow in the terminal. frbit auth status validates the stored credential, frbit auth logout removes it again.

Tokens in scripts and CI

FRBIT_TOKEN supplies a token for a single process and takes precedence over a stored credential, which makes it the right fit for CI jobs, containers and agents:

FRBIT_TOKEN=frbit-at-… frbit apps list
shell

To store a token without an interactive prompt, pass it on standard input. Avoid putting tokens into shell history, command arguments or source control:

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

Profiles

Separate accounts are kept apart by profile. The default profile is named default, and --profile goes before the command group:

frbit --profile work auth login
frbit --profile work apps list
shell

Commands

Commands are grouped by resource and mirror the API. Reads accept --page and repeatable --id, and --json prints the API response unchanged for use with jq.

GroupCovers
authlogin, status, logout
appslist, get, create, update
environmentslist, get, create, update, variables, restart, deploy
deploymentslist, get, logs
domainslist, get
people, teams, payment-methodslist, get
setup, mcp, skillsagent integration

A few everyday examples:

frbit apps list
frbit environments variables get en-a1b2c3
frbit environments deploy en-a1b2c3
frbit deployments logs dp-a1b2c3
shell

Every command and option of the installed version is available under --help, for example frbit apps list --help. The complete command reference is maintained next to the source code.

API responses can contain account data, environment-variable values and application log output. Treat terminal captures and CI logs as sensitive, especially around --json and deployments logs.

MCP server setup

The CLI also wires fortrabbit into a coding agent, so the MCP server and the agent skills do not have to be registered by hand:

frbit setup agent
shell

It detects Claude Code and Codex, registers the MCP server with each and installs the latest skills. Repeating --agent claude-code or --agent codex bypasses detection. The frbit mcp and frbit skills command groups manage either side on its own.

Updates

frbit version reports the installed release, its source commit and build date. Interactive sessions check GitHub for a newer stable version at most once per day. The check is silent on network errors and can be turned off:

export FRBIT_NO_UPDATE_NOTIFIER=1
shell

Upgrading follows the install method: re-run the install script, brew upgrade frbit or npm update --global @fortrabbit/cli.

Uninstall

Sign out while the binary is still in place. frbit auth logout removes the stored credential for the selected profile — repeat it with --profile for every profile in use. An agent setup is undone with frbit mcp remove and frbit skills remove.

Then remove the binary with the counterpart of the install method:

# install script or release archive
rm "$(command -v frbit)"

# Homebrew
brew uninstall frbit

# npm
npm uninstall --global @fortrabbit/cli
shell

brew untap fortrabbit/tap is only needed when no other formula from the fortrabbit tap remains. Generic binary installers clean up after themselves, for example eget --remove or mise uninstall.

The binary is the only thing that goes. Two small files can stay behind: frbit/config.json below the user config directory holds the saved API host, and frbit/update-check.json below the user cache directory holds the last update check. Those two directories are ~/.config and ~/.cache on Linux, ~/Library/Application Support and ~/Library/Caches on macOS, %AppData% and %LocalAppData% on Windows. Tokens are not stored in either — they sit in the credential store of the operating system under the service name frbit-cli and are removed by frbit auth logout.

Written by humans and AI in collaboration.

AI use & editorial processEdit on GitHub ↗