--navigator-initial-scope

CLI: --navigator-initial-scope
REST: navigator_initial_scope

ValueSCOPE

Defaultorigin

LicensePro

Sets where the navigator may go before any --navigator-allow-url glob widens it. Links outside the scope are hidden from the navigator, and navigation outside it is blocked.

Scope	Allowed paths
`origin`	every path on the requested domain, with the same scheme, host, and port
`domain`	every path on the requested domain and any subdomain of it, on any port
`path`	every path at the same level the requested URL and all children paths of that path

A host without a registrable domain, such as an IP address or localhost, is its origin under domain. A redirect at start does not move the scope, and a file: start is its folder and descendants under every scope.

Example

Run locally

zshot -f pipeline.png \
  --navigator-type "anthropic://YOUR_API_KEY@" \
  --navigator-credential email=success@zshot-app.com \
  --navigator-credential password=password \
  --navigate "Log in and open the pipeline" \
  --navigator-initial-scope path \
  https://zshot-cli.com/example_assets/zrm/

{
  "url": "https://zshot-cli.com/example_assets/zrm/",
  "output_type": "png",
  "navigate": "Log in and open the pipeline",
  "navigator_initial_scope": "path",
  "navigator_type": ["anthropic://YOUR_API_KEY@"],
  "navigator_credential": { "email": "success@zshot-app.com", "password": "password" }
}

curl -X POST http://127.0.0.1:3000/ \
  -H "Content-Type: application/json" \
  -d '{"url":"https://zshot-cli.com/example_assets/zrm/","output_type":"png","navigate":"Log in and open the pipeline","navigator_initial_scope":"path","navigator_type":["anthropic://YOUR_API_KEY@"],"navigator_credential":{"email":"success@zshot-app.com","password":"password"}}' \
  -o pipeline.png