Command line

Install and sign in

Create a token under Settings → API tokens. It is shown once; choose read-only or read and write, all projects or one, and when it expires.

pipx install https://cloud.example.com/api/cli/arrah-cli.tar.gz
arrah login --url https://cloud.example.com        # asks for the token, input hidden
arrah whoami

In CI, skip the login and set ARRAH_URL and ARRAH_TOKEN instead.

Everyday commands

arrah projects create --repo you/my-api --from-file .env --deploy
arrah deploy my-api
arrah logs my-api --follow
arrah rollback my-api
arrah env set my-api KEY=value
arrah db create my-api
arrah domains add my-api www.example.com
arrah metrics my-api --range 24h
arrah sessions list
arrah init fastapi --dir my-app

arrah --help lists everything, and each command has its own --help. A project is named by its name, its address or its id; a branch environment is project/branch.

In scripts

--json

Machine-readable output on stdout; progress goes to stderr.

--dry-run

Show what the command would change, and whether it would wait for approval, without changing anything. Exits 1 if it would be refused. More

Exit 0

Done.

Exit 2

The deployment finished but failed.

Exit 3

Nothing was done yet: the action waits for a person to approve it.

Exit 1

Any other error.

Nothing prompts unless it is run in a terminal. Deleting needs --yes.