CLI

Install the CLI, sign in with an API key, and manage everything from your terminal.

The Gheima CLI drives your account from the terminal — deploy, tail logs, and manage services, databases, and storage. It authenticates with an account API key.

Install & sign in#

Shell

npm install -g @gheima/cli
gheima login

Or run without installing: npx gheima <command>.

Create an API key in Settings → API keys, then paste it when prompted (it starts with gh_). The key is stored per profile in ~/.config/gheima/config.json (mode 600). You can also skip login by setting the GHEIMA_API_KEY environment variable.

Auth resolves in this order: the --key flag, then GHEIMA_API_KEY, then the stored profile. Use --profile <name> to keep separate keys (e.g. work vs personal); gheima logout removes one.

Global options#

-k, --key <key>: API key for this call (overrides the env var and stored profile).
-u, --url <url>: API base URL (defaults to https://gheima.ma).
-p, --profile <name>: Which stored profile to use.
--json: Print machine-readable JSON instead of a table.
-v, --version: Print the CLI version.

Account commands#

gheima login: Authenticate with an API key and store it in a profile.
gheima logout: Remove a stored profile.
gheima whoami: Show the account for the active key (name, slug, plan, type).
gheima status: Show account, plan, and resource counts.
gheima open [resource]: Open the dashboard (or a path) in your browser.
gheima completion [shell]: Print a completion script for bash, zsh, or fish.

Service commands#

Commands that take a <service> accept its id, name, or slug. Destructive commands ask to confirm unless you pass -y / --yes.

gheima services: List services (alias of services list; also service, svc).
gheima services get <id>: Show one service in detail.
gheima services create --project <id> --name <name> [--type WEB|WORKER|STATIC] [--repo <url>]: Create a service (type defaults to WEB).
gheima services delete <id> [-y]: Delete a service.
gheima deploy [service]: Trigger a deployment; prompts for the service if omitted.
gheima logs <service> [-f] [-b] [-s <text>]: Show or tail logs. -f follow, -b build logs, -s filter.
gheima env pull <service>: List env var keys with masked values.
gheima env set <service> KEY=value: Set an environment variable.
gheima env rm <service> <key> [-y]: Remove an environment variable.
gheima domains <service>: List custom domains for a service.

Resource commands#

gheima db: List databases (alias databases).
gheima storage buckets: List object-storage buckets.
gheima storage ls <bucket> [prefix]: List objects in a bucket.
gheima storage cp <file> <bucket> [key]: Upload a local file via a presigned URL.
gheima storage get <bucket> <key> [dest]: Download an object.
gheima storage rm <bucket> <key> [-y]: Delete an object.
gheima cron: List cron jobs.
gheima webhooks: List webhooks.

Shell

gheima services create --project prj_1 --name web --type WEB --repo https://github.com/me/app
gheima deploy web
gheima logs web -f -s error
gheima env set web NODE_ENV=production
gheima storage cp ./photo.png my-bucket images/photo.png
gheima services --json | jq '.[].url'

A typical session. Add --json to any command to pipe structured output.

✦ Everything in the dashboard is one command away — script deploys, logs, and resource management from your shell.