--navigator-type

CLI: --navigator-type
REST: navigator_type

ValueCONFIG

LicensePro

Sets the model that drives --navigate, as a provider connection string: a hosted provider, ollama for a local model, or stdio for an external agent. typesafe chooses among the page’s elements and the provided credentials and files, and writes no other text. There is no default; without this flag, --navigate uses the --llm-format-model when one is set. A bare provider name such as anthropic uses the provider’s default model and reads its key from the provider’s environment variable.

Repeat the flag to add navigators the first can escalate to; name=, when=, escalate= and writer= configure each, as navigator options lists.

Example

Run locally

zshot -f pipeline.png \
  --navigator-type "anthropic://YOUR_API_KEY@?model=claude-opus-5-5" \
  --navigator-credential email=success@zshot-app.com \
  --navigator-credential password=password \
  --navigate "Log in and open the pipeline" \
  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_type": ["anthropic://YOUR_API_KEY@?model=claude-opus-5-5"],
  "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_type":["anthropic://YOUR_API_KEY@?model=claude-opus-5-5"],"navigator_credential":{"email":"success@zshot-app.com","password":"password"}}' \
  -o pipeline.png