Urlbox

Configuration

Where the Urlbox CLI stores its configuration, how to read and change it, and how env vars fit in.

Most people never need this page: urlbox login writes everything the CLI needs. It's here for when you want to see or change what's stored.

The config file

urlbox config path

Prints the file location, normally ~/.config/urlbox/config.json. The file is readable only by you, and urlbox login manages its contents: your session, the active org and project, and the active project's render credentials.

Reading and changing values

urlbox config get api_host
urlbox config set api_secret ubx_sk_xxxxxxxxxxxx

The keys you might actually touch:

  • api_secret / api_key — the render credentials. Set them by hand only if you don't use urlbox login (for example on a shared box where you'd rather paste a project secret once).
  • api_host — points the CLI at a different API host. You'll know if you need it.
  • session_token, active_org, active_project — managed by login, logout and the select commands; you rarely set these yourself.

Secret values print masked. Pass --reveal to see one in full:

urlbox config get session_token --reveal

Environment variables

URLBOX_API_SECRET provides the render secret without touching the config file, which is the right shape for CI. An env var beats the stored file when both are present. See CI and headless environments.

On this page