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

# Introduction

> What CodeWarden does on your pull requests, and what it deliberately does not do.

CodeWarden is a GitHub App that reviews pull requests on GitHub.com. When a pull request is opened or pushed to, it reads the change through the GitHub API, asks a language model once, filters the answer, and posts **one review** with inline comments on the lines the pull request added.

It is built to say little and be right when it speaks. A review with nothing worth saying posts few or no comments, and a push that adds nothing new costs nothing.

## What it does

<CardGroup cols={2}>
  <Card title="Reviews each push" icon="code-pull-request" href="/how-a-review-works">
    The first review reads the whole pull request. Every later push is reviewed only for what that push changed.
  </Card>

  <Card title="Follows your repository's rules" icon="file-code" href="/configure/codewarden-yml">
    A `.codewarden.yml` file, read from the base branch, says which paths to skip, which rules apply where, and how many comments a review may carry.
  </Card>

  <Card title="Checks the change against a Jira ticket" icon="ticket" href="/integrations/jira">
    Link a ticket in the pull request and code that contradicts what the ticket states is reported.
  </Card>

  <Card title="Reads a Sentry issue next to the fix" icon="bug" href="/integrations/sentry">
    Link an issue and CodeWarden reads its stack trace, then reports code that would still raise the same error.
  </Card>

  <Card title="Answers when you reply" icon="comments" href="/bot/mentions">
    Reply to one of its comments with `@codewardenapp`. It explains, defends the finding, or concedes and stops raising it.
  </Card>

  <Card title="Shows its work in a console" icon="chart-column" href="/console/organizations-and-roles">
    Every review, including the comments it decided not to post and why, at `app.codewarden.co`.
  </Card>
</CardGroup>

## What it reports

Defects in the code the pull request added: bugs, crashes on inputs the code can receive, security holes, race conditions, resources that are never released, queries that will not scale, and logic that contradicts what the surrounding code or the pull request description says. Each comment carries a [category and a severity](/bot/categories-and-severities).

## What it does not do

* **It does not comment on style.** Naming, formatting, import order, missing tests, missing documentation, and suggestions that start with "consider" are refused by design. Asking for them in `.codewarden.yml` does not change that.
* **It does not report what it cannot see.** It is shown part of a pull request, never all of it, so it never reports that something is "missing" or "not implemented".
* **It does not clone your repository or run anything from it.** No build, no tests, no linters, no scripts. Everything it reads comes through the GitHub API.
* **It does not approve or block pull requests.** It posts a review with comments; merging stays your decision.
* **It does not write to Jira or Sentry.** Both integrations are read-only.
* **It only runs on GitHub.com.** GitHub Enterprise Server, GitLab and Bitbucket are not supported.

## Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Install the App and get your first review.
  </Card>

  <Card title="Plans and AI turns" icon="credit-card" href="/account/plans-and-ai-turns">
    What a plan includes and what counts against it.
  </Card>
</CardGroup>


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