Quick Start
Get PR Hunt running on your repository in under 5 minutes.
1. Get your license key
Subscribe to PR Hunt on the pricing page. Your license key will be emailed to you immediately.
2. Add secrets to your repository
Go to your repo's Settings → Secrets and variables → Actions and add:
3. Create the workflow file
Create .github/workflows/pr-hunt.yml in your repository:
name: PR Hunt
on:
issue_comment:
types: [created]
permissions:
contents: read
pull-requests: write
jobs:
hunt:
if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/pr-hunt run')
runs-on: ubuntu-latest
steps:
- uses: pr-hunt/pr-hunt@v1
with:
license-key: ${{ secrets.PR_HUNT_LICENSE_KEY }}
auth-mode: api-key
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
engine: codex
require-manual-trigger: true
command-trigger: /pr-hunt run
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}4. Open a pull request and comment /pr-hunt run
PR Hunt runs only when manually triggered by a linked paid GitHub account.
Configuration
All inputs are passed via the with: block in your workflow.
| Input | Default | Description |
|---|---|---|
| license-key | — | Required. Your PR Hunt license key. |
| auth-mode | api-key | api-key | codex-login | claude-login |
| engine | codex | Agent engine: codex or claude |
| openai-api-key | — | Required for codex engine. |
| anthropic-api-key | — | Required for claude engine. |
| codex-auth-json | — | Optional ~/.codex/auth.json payload for codex-login. |
| claude-credentials-json | — | Optional ~/.claude/.credentials.json payload for claude-login. |
| require-manual-trigger | true | Only execute on trigger comments. |
| command-trigger | /pr-hunt run | Slash command required on PR comments. |
| pr-number | — | PR number override for workflow_dispatch runs. |
| fleet-size | 10 | Max concurrent agents. |
| duration | 60 | Hunt duration in minutes. |
| max-agents | 0 | Max total agents spawned (0 = unlimited). |
| model | — | Model for agents (engine-specific). |
| reasoning-effort | medium | Reasoning effort level. |
| submit-comments | true | Post bug reports as PR comments. |
| submit-inline-comments | true | Post bugs as inline PR comments. |
Engines
Codex (default)
Use auth-mode: api-key with openai-api-key or auth-mode: codex-login with Codex CLI login credentials.
Claude
Use auth-mode: api-key with anthropic-api-key or auth-mode: claude-login with Claude CLI credentials.
- uses: pr-hunt/pr-hunt@v1
with:
license-key: ${{ secrets.PR_HUNT_LICENSE_KEY }}
anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
engine: claude
model: opus
reasoning-effort: high
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}Outputs
The action sets these outputs for use in subsequent workflow steps:
| Output | Description |
|---|---|
| bugs-found | Total number of bugs found. |
| bugs-confirmed | Number of consensus-confirmed bugs. |
| report-path | Path to the generated Markdown report. |
Troubleshooting
"license key not found"
Ensure PR_HUNT_LICENSE_KEY is set in your repository secrets and passed via the license-key input.
"license validation failed"
Your license key may be invalid or deactivated. Check your email for the correct key. If the issue persists, contact support@pr-hunt.dev.
"codex CLI not found"
This shouldn't happen with the Docker-based action. If running locally, install Codex CLI: npm install -g @openai/codex
"Codex is not logged in"
For auth-mode: codex-login, use a persistent self-hosted runner or pass codex-auth-json from your Codex login state.
"Claude credentials not found"
For auth-mode: claude-login, provide claude-credentials-json or run on a self-hosted runner with Claude already authenticated.
Action times out
The default hunt duration is 60 minutes. Reduce it with duration: 30 or lower fleet-size to reduce API costs.
No bugs found
PR Hunt focuses on real bugs, not style issues. A clean result means the AI agents didn't find logic errors in the diff. You can increase coverage with higher fleet-size or duration.
FAQ
Does my code leave the GitHub runner?
Only the PR diff is sent to the AI provider you configure (OpenAI or Anthropic) via their API. No code is sent to PR Hunt's servers — there are no PR Hunt servers.
How much does the AI API cost per PR?
It depends on diff size and fleet configuration. A typical 30-minute run with 5 agents costs roughly $2–10 in API usage. You control this via fleet-size and duration.
Can I use this on private repos?
Yes. The action runs inside your GitHub Actions runner, so it has access to whatever the GITHUB_TOKEN can read.
Is this a subscription?
Yes — $15/month. Cancel anytime from Stripe. Your license stays active through the end of your billing period. All updates are included while subscribed.
What if I need help?
Email support@pr-hunt.dev.