@urlbox/cli

@urlbox/cli

The official CLI for the Urlbox screenshot and web automation API.

Install

npm install -g @urlbox/cli

Usage

urlbox auth --api-secret sec_xxxxxx                       # one-time
urlbox render https://example.com --output home.png       # capture & save
urlbox screenshot https://example.com --output home.png   # alias: --format png
urlbox pdf https://example.com --output home.pdf          # alias: --format pdf --full-page
urlbox video https://example.com --output home.mp4        # alias: --format mp4

urlbox render https://example.com --dry-run               # preview payload, no API call
urlbox render https://example.com --curl                  # paste-able curl, secret redacted
urlbox render https://example.com --open                  # open result in browser
urlbox render https://example.com --preset article        # news/article preset
urlbox render https://example.com --timeout 3m            # raise per-attempt budget (default 60s)

# Async: queue a render, then poll for completion
urlbox render https://example.com --async                 # returns a renderId
urlbox status ps_abc123 --wait                            # poll until terminal

# Sign a render URL locally (no API call) — for templates / CDNs
urlbox link --url https://example.com --output-format quiet

# Open the Urlbox dashboard in your browser
urlbox dashboard

# Self-discovery
urlbox commands --output-format json                      # full command catalog
urlbox render --help --agent                              # structured JSON help
urlbox schema render                                      # JSON Schema of render options
urlbox skill show                                         # one-page agent guide
urlbox skill install --target claude-code --scope user --yes  # auto-discover by your agent (also: cursor, codex, opencode)

# Diagnostics
urlbox doctor                                             # version + config + auth + reachability

All commands support --output-format json|text|quiet and a built-in --jq <expr> filter (no external jq binary needed).

Validation contract (v0.9.0+): typed flags (--width, --format, --wait-until, ...) are validated locally — fast feedback for type errors and invalid enum values. The --json option is a passthrough: the Urlbox API performs all option validation, so any current or future API option works via --json without needing a CLI update. If a --json key looks like a typo of a documented option, the CLI prints a warning: ... to stderr and still sends the request verbatim.

Multi-account workflows use named profiles (urlbox --profile <name> ...); see urlbox config profile --help.

How it works

The npm package is a thin wrapper around the native Go binary. During postinstall, it downloads the pre-built binary for your platform and architecture (macOS, Linux, or Windows; amd64 or arm64) from the GitHub release. Running urlbox then spawns that binary with your arguments.

Documentation

Full documentation and additional install methods: github.com/urlbox/urlbox-cli

License

MIT