Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ironbee.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

​
Minimal setup

Create a file at .github/workflows/ironbee.yml: 
name: IronBee Verification

on:
  push:
    branches: [main]
  pull_request:
    types: [opened, synchronize]

permissions:
  contents: write
  pull-requests: write
  issues: write

jobs:
  verify:
    runs-on: ubuntu-latest
    timeout-minutes: 45
    steps:
      - uses: actions/checkout@v4

      - uses: ironbee-ai/ironbee-action@v1
        with:
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
Then add your Anthropic API key to your repository secrets:
  1. Go to Settings → Secrets and variables → Actions
  2. Click New repository secret
  3. Name: ANTHROPIC_API_KEY, Value: your key
That’s it. The next push or pull request will trigger a verification run.

​
With application build and start

If your application needs to be built and started before verification: 
- uses: ironbee-ai/ironbee-action@v1
  with:
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
    app_install_command: 'npm ci'
    app_build_command: 'npm run build'
    app_start_command: 'npm run start'
    app_url: 'http://localhost:3000'

​
Required permissions

The action needs these GitHub token permissions to operate:
PermissionPurpose
contents: writeCommit fixes to PR branches, create fix branches
pull-requests: writePost verification report comments, create fix PRs
issues: writeUpdate PR comments via the GitHub API

​
Authentication options

You can authenticate with either: Anthropic API key: 
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
Claude Code OAuth token (alternative): 
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
One of these is required.

​
Next steps

Trigger modes

Configure how the action behaves on different events.

All configuration options

Build commands, app URL, S3 uploads, and more.