Command reference
Every Urlbox CLI command and global flag in one place, from render, screenshot and link to login, projects, storage and doctor.
A complete map of the CLI surface. Run urlbox commands for the same list as machine-readable JSON, or urlbox <command> --help for full detail on any one.
| Command | Description |
|---|
urlbox render [url] | Render a URL to a screenshot, PDF, video or other format. The general command underneath the aliases. |
urlbox screenshot [url] | Capture a screenshot. Alias for render --format png (also aliased shot). |
urlbox pdf [url] | Render as PDF. Alias for render --format pdf --full-page. |
urlbox video [url] | Render as MP4 video. Alias for render --format mp4. |
urlbox link [url] | Generate an HMAC-signed render URL locally, with no API call. See Signed links. |
urlbox status <renderId> | Look up the state of an async render; --wait polls to completion. |
--format · --full-page · --width · --height · --selector · --retina · --block-ads · --dark-mode · --delay · --wait-until · --user-agent · --quality · --preset · --async · --webhook-url · --timeout · --max-retries · --no-retry · --open · --output · --dry-run · --curl · --json
See Rendering for what each does, and --json for passing any other API option.
| Command | Description |
|---|
urlbox login | Sign in via your browser. --org and --project skip the pickers. See Authentication. |
urlbox logout | Sign out and revoke this device's session. |
urlbox whoami | Show the signed-in user and active org/project (alias me). |
urlbox orgs list | List the organisations you belong to (alias org). |
urlbox orgs select [name-or-id] | Switch the active organisation. |
urlbox usage | Render usage for the active organisation this period. |
| Command | Description |
|---|
urlbox projects list | List the active org's projects (alias project). |
urlbox projects select [name-or-id] | Switch the active project. Renders bill to this. |
urlbox projects show <name-or-id> | Show one project (--reveal unmasks the webhook key). |
urlbox projects create <name> | Create a project. --select makes it active immediately. |
urlbox projects rename <name-or-id> <new-name> | Rename a project. |
urlbox projects enable <name-or-id> | Enable a project. |
urlbox projects disable <name-or-id> | Disable a project. Asks y/n; --yes skips. |
urlbox projects delete <name-or-id> | Delete a project. Asks you to retype the name; --yes skips. |
urlbox projects defaults show|set|remove <name-or-id> | Manage the project's default render options (set --json '{…}', --merge to merge instead of replace). |
Storage credentials, proxies and LLM credentials belong to the organisation; create once, assign to any project. Positional targets accept a name or an id (store_…, pool_…, llm_…). Secrets print masked; --reveal unmasks. Deletes ask you to retype the name; --yes skips.
| Command | Description |
|---|
urlbox storage list|show|create|update|delete | Manage S3 or Azure storage credentials. |
urlbox proxies list|show|create|update|delete | Manage your proxies (alias proxy). update replaces the whole URL list. |
urlbox llm list|show|create|update|delete | Manage LLM credentials. Provider is fixed at create. |
urlbox llm test <name-or-id> | Test the credential against its provider. |
urlbox llm models <name-or-id> | List the models the credential can use. |
urlbox projects storage|proxy|llm assign <project> <cred> | Assign a credential to a project (create --assign-to <project> does both in one step). |
urlbox projects storage|proxy|llm unassign <project> | Detach a project's credential. |
| Command | Description |
|---|
urlbox config get <key> | Read a config value (--reveal to unmask secrets). |
urlbox config set <key> <value> | Set a config value. |
urlbox config path | Print the config file path. See Configuration. |
urlbox dashboard | Open urlbox.com/dashboard in your browser (prints the URL on headless hosts). |
| Command | Description |
|---|
urlbox skill install | Install the agent skill (--target claude-code|cursor|codex|opencode, --scope user|project, --yes, --force). |
urlbox skill show | Print the embedded SKILL.md. See Using the CLI from an AI agent. |
| Command | Description |
|---|
urlbox commands | List every command and flag as structured JSON. |
urlbox schema render | Print the JSON Schema for the render payload. See --json & schema. |
urlbox doctor | Check install, config, session, credentials and network. See Troubleshooting. |
urlbox upgrade | Detect the install method and update to the latest version. |
urlbox version | Print version, commit and build date. |
urlbox help [command] | Help about any command. |
These work on any command:
| Flag | Description |
|---|
--output-format | json, text, or quiet. See Output & scripting. |
--jq <expr> | Run a jq expression over the result inline. |
-v, --version | Print the CLI version (root flag). |
Session commands also take --no-retry / --max-retries, matching render and status.
