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

# Quick start

> Add Garnet to a workflow and get your first Run Profile on a PR in minutes.

Garnet runs as a GitHub Action. Add it to your CI workflow, open a PR, and Garnet posts a **Run Profile** back as a comment — what your code actually did when it ran.

<Tip>
  Want it to connect repos and turn on PR comments for you? Install the **GitHub App** at [github.com/apps/garnet-platform](https://github.com/apps/garnet-platform/installations/select_target) (or [app.garnet.ai](https://app.garnet.ai) → **Settings** → **GitHub PR Comments**), and its wizard walks you through the same steps below.
</Tip>

<Steps>
  <Step title="Generate API token" icon="key">
    [app.garnet.ai](https://app.garnet.ai) → **Settings** → **API Tokens** → **Create Token**. Copy the token.

    Need to vet what Garnet can access before you install? See [Trust & security](/trust) — the token is the only secret it uses.
  </Step>

  <Step title="Add repository secret" icon="lock">
    In your repo: **Settings** → **Secrets and variables** → **Actions** → **New repository secret**.

    Set the name to `GARNET_API_TOKEN` and paste your token as the value.
  </Step>

  <Step title="Add Garnet to your workflow" icon="code">
    ```yaml theme={null}
    name: CI

    on:
      push:
        branches: [main]
      pull_request:
        branches: [main]

    jobs:
      build:
        runs-on: ubuntu-latest

        permissions:
          contents: read
          pull-requests: write

        steps:
          - uses: actions/checkout@v4

          - name: Garnet Run Profile
            uses: garnet-org/action@2b7fc9d79b54f551b43358c27424a36064b3e078 # v2
            with:
              api_token: ${{ secrets.GARNET_API_TOKEN }}

          # your existing build/test steps continue here
    ```

    `pull-requests: write` lets Garnet post the Run Profile as a PR comment. [Full GitHub Actions reference](/reference/github-actions) · [Pin to latest SHA](https://garnet.ai/pins)
  </Step>

  <Step title="Check your PR" icon="comment">
    Push or open a PR. Within seconds, Garnet posts a **Run Profile** as a comment right on the pull request — the payoff moment:

    ```
    ✅  Garnet · Run Profile — Clean

    Checks   3 passed
    Egress   api.github.com · registry.npmjs.org · objects.githubusercontent.com

    View the full Run Profile → app.garnet.ai/runs/…
    ```

    That comment is the product; the [dashboard](https://app.garnet.ai) is the full renderer of the same Run Profile. New to reading one? [The Run Profile](/run-profile) walks through the anatomy and what each state means.
  </Step>
</Steps>