Skip to main content
The Brimble CLI deploys projects and manages them from your terminal. It uses the same API key as the dashboard. Inside a linked directory, commands default to that project, so brimble deploy, brimble logs, and brimble env list need no project name.

​
Install

On macOS or Linux:
The script downloads the latest release for your system, checks it against the release checksums, and installs brimble to /usr/local/bin, or to ~/.local/bin when /usr/local/bin isn’t writable. If that directory isn’t on your PATH, the script prints the line to add.To pin a version or choose the directory:
Check the install:

​
Upgrade

upgrade uses the method you installed with. A Homebrew install is upgraded with brew upgrade --cask brimble, and a go install build with go install. An install from the install script or a downloaded archive is replaced in place, after the download is checked against the release checksums. It asks before it runs. Pass -y to skip the question. If you see a permission error, the CLI is installed in a directory you can’t write to. Re-run with sudo, or reinstall with the install script. When a newer version is out, the CLI tells you after a command finishes, with the command to run. It checks at most once a day, and stays quiet in CI, in scripts, and with -o json. Set BRIMBLE_NO_UPDATE_NOTIFIER=1 to turn the notice off.

​
Log in

Create an API key at Settings → API keys, then:
The command offers to open that page, asks you to paste the key (the input is hidden), checks the key, and saves it. If you belong to teams, it asks which workspace later commands should use. Change that later with brimble team switch.
--api-key and BRIMBLE_API_KEY override the saved key for one command. --skip-validate saves a key without checking it. brimble logout removes the saved key and the default team. If BRIMBLE_API_KEY is still set in the environment, the CLI tells you. The key is stored in brimble/config.json under your user config directory. The file is not a git config and should not be committed.
This writes .brimble/project.json in the current directory. The file holds the project ID, project name, and team ID. It does not hold your API key. Commands run in that directory, or in a folder below it, use the linked project when you omit the project argument. brimble unlink removes the file.
Add .brimble/ to .gitignore if you do not want the link file in the repository. It contains IDs, not secrets, and it is safe to commit when a repo should always deploy one project.

​
Which project a command uses

  1. The project name or ID you passed.
  2. Otherwise, the project linked to this directory.
  3. Otherwise, a picker, when you are in a terminal.
In a script, with no argument and no link, the command exits with an error instead of prompting. --team accepts a team ID, name, or slug. Resolution order:
  1. --team
  2. BRIMBLE_TEAM_ID
  3. The team on the linked project
  4. The workspace saved by brimble team switch or brimble login
personal (or an empty team) is your personal workspace.

​
Output

Human-readable output is the default. Pass -o json for JSON on stdout. Progress, warnings, and errors go to stderr, so you can pipe stdout.
-o accepts table or json.

​
Global flags

Destructive commands ask before they act. In a non-interactive shell they refuse unless you pass -y / --yes.

​
Where to go next

Deploy

Ship a project and follow the build.

Projects

List, inspect, and change project settings.

Logs

Stream application logs and read build output.

Environment variables

Set, pull, and push secrets.

Domains and teams

Domains, environments, and team members.

CI

Run the CLI in a pipeline.
Last modified on October 16, 2026