Authentication

Sign in

urlbox login

Your browser opens. Approve, and you're in. If you belong to more than one organisation the CLI asks which one, and the same for projects; --org <name-or-id> and --project <name-or-id> skip the questions. The CLI stores your session and the active project's render credentials in ~/.config/urlbox/config.json (readable only by you), so renders work immediately.

Who am I, and where?

urlbox whoami           # signed-in user, active org and project (alias: me)
urlbox orgs list        # organisations you belong to
urlbox orgs select      # switch the active org
urlbox projects select  # switch the active project (renders bill to this)

Sign out

urlbox logout

Revokes this device's session on the server and clears the stored credentials. Sessions on other devices and your dashboard login are untouched. If your session expires, commands tell you; run urlbox login again.

CI and headless environments

Where a browser can't open, set your project's API secret as an env var instead; no sign-in is needed:

export URLBOX_API_SECRET=ubx_sk_xxxxxxxxxxxx

You'll find it under your project in the dashboard. For a one-shot override on a single command there's also --api-secret-stdin / --api-secret-file.

When more than one source is present, the highest-priority wins: command flag → environment variable → your stored config.

urlbox link needs the publishable API key as well as the secret. urlbox login stores both automatically. With env-var auth, add the key with --api-key <key> or store it once with urlbox config set api_key <key>.

Verify

urlbox doctor

doctor checks your setup end to end: the install and config file, whether your session is still valid, which org and project are active, that a render credential is in place, and that the Urlbox API is reachable from your machine. Anything failing comes with a hint for fixing it.