# Navigator

Source: https://zshot-cli.com/reference/navigator/
Markdown: https://zshot-cli.com/reference/navigator/index.md
Section: [Reference](https://zshot-cli.com/reference/)

[`--navigate`](/reference/flags/navigator/navigate) hands the page to a navigator that carries out instructions before the capture. The navigator is a [model](/reference/llm_connections) chosen with [`--navigator-type`](/reference/flags/navigator/navigator-type), or an external agent over [`stdio`](/reference/llm_connections/stdio). Each step it reads the page, takes one action, and reads the result.

A session succeeds when the navigator judges the instructions done, or when a [`--navigator-goal`](/reference/flags/navigator/navigator-goal) is met, and the capture is taken of the page it ended on. It fails with exit code 9 at [`--navigator-max-steps`](/reference/flags/navigator/navigator-max-steps), when the navigator reports the task impossible, or when a [stalled](/reference/navigator/navigators#stalls) navigator with no one to escalate to keeps repeating one action. A failed session writes no output. A run with no output type writes [`goal`](/reference/formats/goal): what the navigator said when it finished.

Every other `--navigator-*` option tunes a navigation and needs `--navigate`, or the run exits with code 3 naming both. A server takes them as defaults for the requests it serves. `--navigator-type` alone also names the model an [LLM output](/reference/llm_connections) formats with.

| Page | Covers |
| --- | --- |
| [Actions](/reference/navigator/actions) | How the navigator clicks, types and scrolls, and what of the page it is shown |
| [Navigators](/reference/navigator/navigators) | Several navigators in one session: escalation, stalls, outages and a writer |
| [Scope](/reference/navigator/scope) | Where the navigator may go, and the URL globs that widen it |
| [Credentials](/reference/navigator/credentials) | Values ZShot types without the model seeing them, and credential helpers |
| [Data and Files](/reference/navigator/data-and-files) | Task data the navigator sees, and files it uploads |

## Related

Flags:

- [`--navigate`](https://zshot-cli.com/reference/flags/navigator/navigate/)
- [`--navigator-type`](https://zshot-cli.com/reference/flags/navigator/navigator-type/)
- [`--navigator-goal`](https://zshot-cli.com/reference/flags/navigator/navigator-goal/)
- [`--navigator-max-steps`](https://zshot-cli.com/reference/flags/navigator/navigator-max-steps/)
- [`--navigator-step-timeout`](https://zshot-cli.com/reference/flags/navigator/navigator-step-timeout/)

Topics:

- [LLM Connections](https://zshot-cli.com/reference/llm_connections/)
- [Goal](https://zshot-cli.com/reference/formats/goal/)
- [Timeouts](https://zshot-cli.com/reference/timeouts/)
- [Log in, then capture](https://zshot-cli.com/examples/navigate-login/)

## Navigation

- [Examples](https://zshot-cli.com/examples/)
- [Download](https://zshot-cli.com/download/)
- [Purchase](https://zshot-cli.com/purchase/)
- [Reference](https://zshot-cli.com/reference/)
  - [Formats](https://zshot-cli.com/reference/formats/)
  - [Flags](https://zshot-cli.com/reference/flags/)
  - [Agents](https://zshot-cli.com/reference/agents/)
  - [Configuration](https://zshot-cli.com/reference/configuration/)
  - [Crawling](https://zshot-cli.com/reference/crawling/)
  - [Docker](https://zshot-cli.com/reference/docker/)
  - [Exit Codes](https://zshot-cli.com/reference/exit_codes/)
  - [Linux](https://zshot-cli.com/reference/linux/)
  - [LLM Connections](https://zshot-cli.com/reference/llm_connections/)
  - [LLM Formatting](https://zshot-cli.com/reference/llm_formatting/)
  - [Local Inputs](https://zshot-cli.com/reference/inputs/)
  - **Navigator**
    - [Actions](https://zshot-cli.com/reference/navigator/actions/)
    - [Navigators](https://zshot-cli.com/reference/navigator/navigators/)
    - [Scope](https://zshot-cli.com/reference/navigator/scope/)
    - [Credentials](https://zshot-cli.com/reference/navigator/credentials/)
    - [Data and Files](https://zshot-cli.com/reference/navigator/data-and-files/)
  - [Security](https://zshot-cli.com/reference/security/)
  - [Server](https://zshot-cli.com/reference/server/)
  - [Shell completions](https://zshot-cli.com/reference/shell_completions/)
  - [Storage](https://zshot-cli.com/reference/storage/)
  - [Timeouts](https://zshot-cli.com/reference/timeouts/)
  - [Web Bot Auth](https://zshot-cli.com/reference/web_bot_auth/)
- [Support](https://zshot-cli.com/support/)
- [Changelog](https://zshot-cli.com/changelog/)

Site index: https://zshot-cli.com/llms.txt