Back to Strix

GitHub Actions

docs/integrations/github-actions.mdx

0.8.31.2 KB
Original Source

Integrate Strix into your GitHub workflow to catch vulnerabilities before they reach production.

Basic Workflow

yaml
name: Security Scan

on:
  pull_request:

jobs:
  strix-scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Strix
        run: curl -sSL https://strix.ai/install | bash

      - name: Run Security Scan
        env:
          STRIX_LLM: ${{ secrets.STRIX_LLM }}
          LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
        run: strix -n -t ./ --scan-mode quick

Required Secrets

Add these secrets to your repository:

SecretDescription
STRIX_LLMModel name (e.g., openai/gpt-5.4)
LLM_API_KEYAPI key for your LLM provider

Exit Codes

The workflow fails when vulnerabilities are found:

CodeResult
0Pass — No vulnerabilities
2Fail — Vulnerabilities found

Scan Modes for CI

ModeDurationUse Case
quickMinutesEvery PR
standard~30 minNightly builds
deep1-4 hoursRelease candidates
<Tip> Use `quick` mode for PRs to keep feedback fast. Schedule `deep` scans nightly. </Tip>