# quickstarted

> Test whether an AI agent can complete your quickstart by following your docs.

Every page below is also available as raw Markdown: append `.md` to any
URL, or use the links here, which already point at the Markdown.

- [Home](https://snehankekre.com/quickstarted/index.md): Test whether an AI agent can complete your quickstart by following your docs.

## Getting started

- [Install](https://snehankekre.com/quickstarted/getting-started/install.md): Install quickstarted and check what your machine can enforce.
- [Your first run](https://snehankekre.com/quickstarted/getting-started/first-run.md): Point a model at real documentation and watch whether it can finish.
- [Agent mode in depth](https://snehankekre.com/quickstarted/getting-started/agent-mode.md): Choosing a model, bounding the cost, and reading what a run left behind.

## Guides

- [Writing tasks](https://snehankekre.com/quickstarted/guides/writing-tasks.md): The rules that separate a task which measures your docs from one that measures luck.
- [Replay mode](https://snehankekre.com/quickstarted/guides/replay-mode.md): Run the commands your documentation actually prints, for free, on every push.
- [Sandboxing](https://snehankekre.com/quickstarted/guides/sandboxing.md): What each backend actually enforces, and when the difference matters.
- [Pass rates](https://snehankekre.com/quickstarted/guides/pass-rates.md): Why a single run is a sample, and how runs that prove nothing stay out of your numbers.
- [Measuring llms.txt](https://snehankekre.com/quickstarted/guides/affordances.md): Presence is a checklist item. Effect is a measurement. quickstarted does the second one.
- [Running in CI](https://snehankekre.com/quickstarted/guides/ci.md): Gate merges on replay, run agent mode on a schedule, and keep a rate limit from turning a job red.
- [Cost and budgets](https://snehankekre.com/quickstarted/guides/cost.md): Token counts are always reported. Dollars appear only if you supply the rates.

## Reference

- [CLI](https://snehankekre.com/quickstarted/reference/cli.md): Every command and flag. `quickstarted` and `qstart` are the same program.
- [Task schema](https://snehankekre.com/quickstarted/reference/task-schema.md): Every field of a task file, and what the loader rejects.
- [Results schema](https://snehankekre.com/quickstarted/reference/results.md): `results.json`, version 2.0. New fields are added; existing ones keep their meaning.
- [Trace events](https://snehankekre.com/quickstarted/reference/trace.md): `trace.jsonl`, one JSON object per line, in the order things happened.
- [Environment variables](https://snehankekre.com/quickstarted/reference/environment.md): What quickstarted reads, and what the sandbox never sees.

## Why it works this way

- [Deterministic scoring](https://snehankekre.com/quickstarted/explanation/scoring.md): Why a shell script decides, and no model ever does.
- [The egress proxy](https://snehankekre.com/quickstarted/explanation/proxy.md): Why documentation is unreachable from the shell, and what that buys.
- [Compared to other tools](https://snehankekre.com/quickstarted/explanation/comparison.md): What quickstarted does that adjacent tools do not, and where they are the better choice.