RimbraDocsDashboard

Rimbra CLI

Deploy a folder from your terminal, follow builds and logs, and manage variables and domains with the rimbra command.

Install

On macOS and Linux, run the installer. It puts rimbra in /usr/local/bin, or ~/.local/bin when that isn’t writable. On Windows, download rimbra-windows-amd64.exe from the link below and run it from a terminal.

bash
curl -fsSL https://rimbra.app/install.sh | sh
rimbra version

Sign in

  1. Run rimbra login. Your browser opens on Rimbra.
  2. Pick the workspace the CLI works in and its access: Developer can deploy and change things, Viewer only reads.
  3. Choose Allow and go back to the terminal. You stay signed in; the CLI renews its access on its own.

Deploy a folder

Run rimbra deploy in the folder of your app. The first deploy asks for a name and creates the application; later deploys from the same folder are new versions of it, with the same address, variables and domains. The build log follows in the terminal until the app is live.

node_modules, .git, build caches and anything in .gitignore or .rimbraignore stay behind. So do .env files: set variables with rimbra env set. The folder remembers its application in .rimbra/project.json, which is added to .gitignore.

bash
rimbra deploy
rimbra deploy ./site --name my-site
rimbra deploy --no-wait

Commands

[app] can be left out in a folder you’ve deployed.

CommandWhat it does
rimbra appsYour applications, with status and address
rimbra inspect [app]Recent builds with their ids, settings and previews
rimbra logs [app]Recent runtime logs; -f keeps following, --build shows the latest build
rimbra open [app]Opens the live address
rimbra redeploy [app]Builds the live source again and follows it
rimbra rollback [app] <id>Makes an earlier build live again, without rebuilding
rimbra cancel [app]Stops a running build; the live version keeps serving
rimbra env ls [app]Variable names and environments (values stay hidden)
rimbra env set [app] KEY valueAdds or changes a variable; --scope Preview or Development
rimbra domains lsYour domains and their status
rimbra domains add [app] example.comConnects a domain and prints the DNS records to add
rimbra tunnel 3000Puts localhost:3000 at a public HTTPS address (see Tunnels)
rimbra whoamiThe workspace and account you’re signed in as

In CI or scripts

rimbra deploy --yes takes the folder name as the application name without asking. RIMBRA_ACCESS_TOKEN sets an access token for one run.