Skip to content

For the complete documentation index, see llms.txt. Markdown versions are available by appending .md to documentation page URLs. Read the agent handbook.

Zortex Docs
Start searching Install Vision
About this handbook

About this handbook

A practical manual for people and agents, with the same guidance available as web pages and Markdown.

On this page

The purpose

This handbook teaches you to use Vision. A person should be able to complete supported tasks from these instructions even without an agent: find the right workflow, satisfy its prerequisites, follow the steps, recognize the result, and recover when something fails.

The same level of detail lets an agent find and perform the correct operation. The handbook is organized around tasks and decisions. Internal architecture belongs here only when it explains something you need to choose, configure, or diagnose.

How to use it

Start with Get started for your first successful read. Use Choose a workflow when you know the outcome you want. Task guides explain the procedure; CLI & MCP provides exact commands and tool inputs; Settings covers operation and recovery.

Command examples identify required values. Replace placeholders such as <returned-session-id> with values from your own result. Do not copy illustrative IDs or assume an example output was observed on your computer.

Intended experience and current availability

The handbook defines the intended product experience. When implementation work addresses a mismatch, the product's behavior, sequence, or agent calls should be corrected to meet that experience. A defect is not a reason to quietly weaken the documented goal.

Current availability remains explicit. A guide must not tell you to click an unavailable control or claim a feature shipped merely because source code exists. Where an intended workflow is not available, the guide identifies the gap and a supported alternative when one exists. Installed tool schemas govern valid executable calls and permissions.

Editing the handbook can stand alone. It does not automatically change the product, regenerate a bundled copy, publish a package, or update an existing installation.

Read the same content in Markdown

Format Use
Topic index Find the smallest relevant guide.
Any page's View Markdown link Read or copy that complete page without the navigation shell.
Complete handbook Obtain every published guide in one document.
Version manifest Identify the content version, page URLs, and integrity hashes.

The web pages, Markdown, search index, and handbook are generated from one authored corpus. Older addresses continue to the corresponding current guide.

Read it through an agent

Where your installation exposes the tools, request:

Text
indra.instruction({})
indra.handbook({})

The equivalent terminal commands are:

Shell
zortex instruction
zortex handbook

These requests can return installed operational guidance and handbook metadata. Versions containing the web-backed reader check for updates at most once per five minutes on a handbook read. They verify the content and retain a known-good cached or bundled copy when the network fails. Inspect source, version, checkedAt, stale, and refreshError when freshness matters. Older installations may not contain that reader; the website remains directly readable.

Read only the relevant guide and current action schema before acting. A handbook describes usage; it cannot install an unavailable tool, replace the user's instructions, or expand account permissions.

When a guide does not match your installation

Record the command or control you tried, your installed version, the relevant page, the actual result, and the expected result. Check Troubleshooting before repeating a write or starting a new connection. This evidence distinguishes a documentation error, an older installation, and a product defect without losing the intended outcome.

Suggested