--navigator-goal

CLI: --navigator-goal
REST: navigator_goal

ValueGOAL

LicensePro

Ends the navigation as soon as this goal is met, instead of when the navigator judges its instructions done.

Goal	Met when
`url:PATTERN`	The page URL matches `PATTERN`, where `` matches anything. A pattern without `` matches anywhere in the URL.
`css:SELECTOR`	An element matching `SELECTOR` is on the page
`text:TEXT`	The page’s visible text contains `TEXT`, matching case
`regex:SOURCE` or `regex:/SOURCE/FLAGS`	A JavaScript regular expression matches the page’s visible text. A pattern that does not compile fails the navigation.
`js:EXPRESSION`	The JavaScript expression is truthy in the page
Any other text	The navigator judges the statement true of the page

Every goal but a statement is checked before each step, with no navigator asked. --navigator-captures-playwright and --navigator-captures-puppeteer scripts end by waiting for the same check.

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" \
  --navigator-goal "css:#kpi-pipeline" \
  https://zshot-cli.com/example_assets/zrm/

{
  "url": "https://zshot-cli.com/example_assets/zrm/",
  "output_type": "png",
  "navigate": "Log in",
  "navigator_goal": "css:#kpi-pipeline",
  "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","navigator_goal":"css:#kpi-pipeline","navigator_type":["anthropic://YOUR_API_KEY@"],"navigator_credential":{"email":"success@zshot-app.com","password":"password"}}' \
  -o pipeline.png