> ## 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.

# Quickstart

> Sign up, tell Qodex what to do first, and read your first scenarios and findings in a few minutes.

# Quickstart

Use this guide to sign up, point Qodex at your app, API, or repo, and understand the results in a few minutes.

Qodex starts from what you want done first. You give the agent enough context to test safely, and then review the scenarios and findings it creates.

## Prerequisites

* A target to test: a public web URL, a staging URL with test credentials, an OpenAPI spec, a Postman collection, or a curl command.
* For PR review: a GitHub or GitLab repository you can connect to Qodex.
* Optional: your own OpenAI key for BYOK mode.

## 1. Create your account

Sign up at [agents.qodex.ai](https://agents.qodex.ai) with email, Google, or GitHub. Email signups confirm the address with a code.

New accounts start with a 14-day free trial. No credit card is needed. See [Plans and pricing](https://qodex.ai/docs/account-plans-and-pricing.md).

## 2. Tell Qodex about you

The first screen, **About you**, asks for your name and company name. A work email and your role are optional. Click **Continue**.

## 3. Choose what Qodex should do first

Qodex asks **What do you want Qodex to do first?** Pick one card. You can do the rest later in the same project.

| Card | What you give Qodex | What happens next |
| - | - | - |
| **Review my pull requests** | Connect a repo | Click **Connect GitHub** or **Connect GitLab**, then pick the repo to review. |
| **Test my APIs** | Paste a spec or a curl | A chat opens and Qodex imports the spec, writes the first scenarios, and runs them. |
| **Test my UI** | Give us your app's URL | A chat opens and Qodex explores your app in a real browser. |
| **Check API security** | Paste a spec | A chat opens and Qodex imports the spec and reads the security posture of your endpoints. It saves proposed security checks as drafts without running them. |

For the three testing cards, the next screen has one box, **What Qodex should know**. Paste a spec URL, a curl, or your app's URL, and add anything Qodex should know, such as how to log in. To add a spec file, click **Attach a file**. Then click **Start**.

For PR review on GitHub, Qodex reviews your newest open pull request right away and comments on it, then reviews every new pull request after that. On GitLab, you pick the first merge request to review from the **PR review** page, so nothing posts without your click.

Your project is created at this step. To look around first, click **Skip, take me to the app** on the cards screen or **Do it later** on the next one.

## 4. Watch the first run

In chat, Qodex streams each step, tool call, and sub-agent as it works, including a live view of the browser it drives. You can steer it at any time:

```text theme={null}
Explore the login flow and check for IDOR on the /users endpoint.
```

The coordinator breaks the request into smaller testing tasks, starts the right specialty agents, and reports back in the same chat.

## 5. Review the results

When the work finishes, Qodex shows:

* Scenarios saved as `draft` so a human can review them before they become active.
* Findings classified by severity (critical, high, medium, low, info), each with reproduction steps and evidence.
* A test run record with per-step screenshots, DOM snapshots, console, and network logs on failure.

Promote a scenario to `active` when you want it included in scheduled or event-driven runs.

## Find your way around

**Home** shows a **Get started** row until you finish setting up, with the next step one click away. The left navigation groups everything else:

| Section | Rows |
| - | - |
| Top | **Home**, **Findings** |
| **Autopilot** | **Agents**, **Tasks**. See [Autopilot](https://qodex.ai/docs/autopilot.md). |
| **Code** | **PR review**, **Code scan**, **Documentation** |
| **Test** | **Scenarios**, **Test runs**, **Load tests**, **Security scans** |
| **Context** | **API**, **UI**, **Knowledge**, **Environments** |

Click a section name to fold or unfold it. A new project opens only the section that matches the card you picked first. **Load tests** appears only when load testing is switched on for the project ([Load testing](https://qodex.ai/docs/load-testing.md) explains the page). Schedules open from the **Test runs** page.

Below the sections, **Chats** lists your three most recent chats. Click **All chats** to see every chat in the project, or **New chat** at the top of the navigation to start one.

The account menu at the bottom of the navigation holds **Settings**, **Team**, **Usage**, and **Sign out**. Click the project name at the top of the navigation to switch projects or create a **New Project**.

## Try it yourself

> [card] [Send an OpenAPI spec](https://qodex.ai/docs/api-testing-openapi-import.md)
>
> Import a spec and watch Qodex create coverage for discovered endpoints.

> [card] [Connect a GitHub repo](https://qodex.ai/docs/pr-review-install-github-app.md)
>
> Install the GitHub App and get inline review comments on the next PR.

## Next steps

> [card] [How Qodex works](https://qodex.ai/docs/how-qodex-works.md)
>
> Learn how the coordinator, sub-agents, scan types, and cost model fit together.

> [card] [Concepts](https://qodex.ai/docs/concepts-scenarios.md)
>
> Understand scenarios, scripts, findings, skills, memory, and projects.

> [card] [Autopilot](https://qodex.ai/docs/autopilot.md)
>
> Let agents keep testing between your chats.

> [card] [Home dashboard](https://qodex.ai/docs/dashboards)
>
> Read what Qodex protects and what it did.


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