The Arvumi CLI

Install from source

The CLI lives in the Arvumi Rust repository. With Rust and Cargo installed, run this from a source checkout:

cargo install --path crates/arvumi-cli --locked
arvumi --help

If you do not have a source checkout, use the dashboard or ask your operator for CLI installation access.

Sign in

arvumi login --api https://app.arvumi.com

The command opens browser sign-in. After authenticating, follow the page’s CLI configuration instructions. You can also run arvumi init and enter the API endpoint and key interactively. Treat the displayed key and saved configuration as credentials; do not share them or commit them.

Link a project

Replace uppercase identifiers such as PROJECT_UUID and DEPLOYMENT_UUID with the actual IDs from your dashboard. A project’s UUID appears in its dashboard URL.

arvumi link PROJECT_UUID

This writes project configuration to .arvumi in the current directory. Commands that accept a project can use this link or an explicit --project option.

Deploy a pushed commit

git push origin main
arvumi deploy --branch main
arvumi list PROJECT_UUID
arvumi logs DEPLOYMENT_UUID

The CLI starts a build from the project’s configured remote repository. It does not upload local files. Without --branch, it uses your current local Git branch when available. Add --commit COMMIT_SHA to select a specific commit that exists in the remote repository; otherwise the selected branch is resolved for the deployment.

Common commands

Run these from a linked project directory. See each guide for required setup and configuration details.

Find command help

arvumi deploy --help
arvumi environments create --help
arvumi domain add --help
arvumi db connect --help

Use a custom environment UUID, rather than its display name, when a command asks for an environment other than production or preview. Use the dashboard for secret values to keep them out of command history.