> ## Documentation Index
> Fetch the complete documentation index at: https://qodex.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenQodex docs

> OpenQodex is open source code review that runs inside your coding agent, before you push.

<Note>
  These pages are generated from the [docs folder](https://github.com/openqodex/openqodex/tree/main/docs) of the openqodex repository. To change a page, edit it there.
</Note>

OpenQodex is open source code review that runs inside your coding agent, before you push.

These pages ship inside the npm package. `npx openqodex guide <topic>` prints one in your terminal, offline. The topic is the file name without `.md`.

## Words used in these pages

* Change: the commits not yet pushed plus everything uncommitted, untracked files included.
* Changed lines: the lines the change adds or edits. Context lines around them do not count.
* Scanner: a program that checks code without a model, such as gitleaks or semgrep.
* Finding: one problem at one place in the code, with a severity.
* Candidate: a scanner finding on a changed line, waiting for the agent to verify it.
* Brief: the text `openqodex review --agent` prints for the agent to review from.
* Report: the result of a scan or a review, written as `report.md`, `report.json` and `report.sarif`.
* Verdict: `passed` or `blocked`.

## Pages

* [`quickstart`](/docs/openqodex/quickstart): install OpenQodex and run the first review.
* [`cli`](/docs/openqodex/cli): every command, flag and exit code.
* [`config`](/docs/openqodex/config): every key of `.openqodex.yaml`.
* [`scanners`](/docs/openqodex/scanners): the thirteen built-in scanners.
* [`custom-scanners`](/docs/openqodex/custom-scanners): add any scanner by its GitHub link.
* [`agents`](/docs/openqodex/agents): what `init` writes for each coding agent.
* [`github-action`](/docs/openqodex/github-action): run the scan on pull requests.
* [`security`](/docs/openqodex/security): what runs, what is sent where, and where files go.
* [`telemetry`](/docs/openqodex/telemetry): there is none.
* [`faq`](/docs/openqodex/faq): short answers.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.