Get Started with NeuronX Guard

Follow these steps to start getting AI code reviews on your PRs.

Install the GitHub App

Click the button below to install NeuronX Guard on your GitHub repos. You can select specific repos or all repos in your account.

Install NeuronX Guard

After installing, Guard will create a welcome issue on each repo to confirm it's working.

Open Your First PR

Create a pull request on any installed repo. Guard reviews automatically — no config needed.

Quick test: Create a branch, add a file with password = "admin123", open a PR. Guard will flag the hardcoded secret within seconds.

See Your Review

Guard posts results directly on your PR:

Check Run badge (green = clean, red = errors)
Inline comments on exact lines with issues
Summary comment with all findings grouped by severity
APPROVE or REQUEST_CHANGES review action

Use PR Commands

Comment any of these on your PR:

/guard explain      — Detailed explanation of each finding
/guard dismiss      — Dismiss and suppress this review's issues
/guard re-review    — Trigger a fresh review after pushing fixes
/guard quality      — Show your repo's quality score (A-F)
/guard leaderboard  — Developer rankings by code quality
/guard report       — Compliance report for audits
/guard config       — Show current configuration

Configure (Optional)

Add .neuronx-guard.yml to your repo root to customize:

checks:
  security: true
  complexity: true
  llm_review: true
ignore_files:
  - "tests/*"
  - "docs/*"
severity_threshold: warning

Not required — all checks are enabled by default.

Add CI or VS Code (Optional)

Use Guard in more places:

GitHub Actions: Add sreejagatab/neuronx-platform/.github/actions/neuronx-guard@main to your workflow. No app install needed.

VS Code: Install the extension from vscode-extension/. Scans on save, diagnostics on exact lines. Ctrl+Shift+G to scan.

Your API key is in the dashboard — use it for CI and VS Code configuration.

You're all set!

Guard will review every PR automatically from now on.

Go to Dashboard