CLI Commands
This page documents the active Reshot CLI surface used across setup, local capture, hosted publish, and certified-target workflows.
Global options
| Option | Description |
|---|---|
--help, -h | Display help for a command |
--version, -V | Output the installed CLI version |
--config, -c | Path to the config file (default: reshot.config.json) |
Setup and auth
reshot setup
Interactive setup wizard for first-run onboarding.
reshot setupreshot auth
Authenticate with hosted Reshot services when you want managed publish and review workflows.
reshot authreshot init
Initialize reshot.config.json manually.
reshot initRecording
reshot record
Record a scenario from a live browser session.
reshot record "Billing Overview" --browser| Option | Description |
|---|---|
--browser | Launch Chrome with remote debugging before recording |
--url <url> | Open a URL when launching the browser |
--port <port> | Override the Chrome debugging port |
--refresh-session | Refresh auth session without re-recording |
reshot chrome
Hidden compatibility command for launching Chrome with debugging. Prefer
reshot record --browser.
Execution
reshot run
Run scenarios from reshot.config.json.
reshot run [options]| Option | Description |
|---|---|
--scenarios, -s | Comma-separated scenario keys |
--all-variants | Run all configured variant combinations |
--variant <json> | Override a variant payload |
--no-headless | Run the browser visibly |
--concurrency <n> | Parallel browser workers |
--diff | Enable baseline comparison |
--cloud | Compare against cloud baselines |
reshot studio
Open the local review and management UI.
reshot studioreshot capture
Compatibility alias for reshot run and optional publish flows. Prefer
reshot run and reshot publish in new docs.
Publishing and delivery
reshot publish
Upload assets to hosted delivery and create review items for changed visuals.
reshot publish [options]| Option | Description |
|---|---|
--dry-run | Preview without uploading |
--message, -m | Publish message override |
--force, -f | Skip confirmation |
--tag <tag> | Version tag for the publish |
reshot pull
Download the published asset manifest.
reshot pull [options]reshot verify publish
Verify publish, pull, and hosted asset delivery.
reshot verify publish [options]| Option | Description |
|---|---|
--scenarios, -s | Limit verification to scenario keys |
--tag <tag> | Version tag for the verification publish |
--message, -m | Publish message override |
--json | Output JSON report |
Certified-target commands
reshot doctor target
Audit target configuration, readiness markers, and contract health.
reshot doctor target [options]| Option | Description |
|---|---|
--scenarios, -s | Limit auditing to scenario keys |
--json | Output JSON report |
reshot certify
Run the full certified-target pipeline.
reshot certify [options]| Option | Description |
|---|---|
--scenarios, -s | Limit certification to scenario keys |
--tag <tag> | Version tag for certification publish |
--message, -m | Publish message override |
--json | Output JSON report |
Status and drift management
reshot status
View project status, sync history, and drift summary.
reshot status [options]reshot drifts
List and manage drift items.
reshot drifts [action] [id]Environment variables
| Variable | Description |
|---|---|
RESHOT_API_KEY | Hosted API key used by publish and verify workflows |
RESHOT_PROJECT_ID | Optional project scope for hosted auth flows |
RESHOT_DEBUG | Enable verbose debugging output |