Skip to main content
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.
Want it to connect repos and turn on PR comments for you? Install the GitHub App at github.com/apps/garnet-platform (or app.garnet.ai → Settings → GitHub PR Comments), and its wizard walks you through the same steps below.

Generate API token

app.garnet.ai → Settings → API Tokens → Create Token. Copy the token.Need to vet what Garnet can access before you install? See Trust & security — the token is the only secret it uses.

Add repository secret

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.

Add Garnet to your workflow

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 · Pin to latest SHA

Check your PR

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 is the full renderer of the same Run Profile. New to reading one? The Run Profile walks through the anatomy and what each state means.