e38f523a45
* feat: add to readme new keys * feat: shoutout strix models, docs * fix: mypy error * fix: base api * docs: update quickstart and models * fixes: changes to docs uniform api_key variable naming * test: git commit hook * nevermind it was nothing * docs: Update default model to claude-sonnet-4.6 and improve Strix Router docs - Replace gpt-5 and opus-4.6 defaults with claude-sonnet-4.6 across all docs and code - Rewrite Strix Router (models.mdx) page with clearer structure and messaging - Add Strix Router as recommended option in overview.mdx and quickstart prerequisites - Update stale Claude 4.5 references to 4.6 in anthropic.mdx, openrouter.mdx, bug_report.md - Fix install.sh links to point to models.strix.ai and correct docs URLs - Update error message examples in main.py to use claude-sonnet-4-6 --------- Co-authored-by: 0xallam <ahmed39652003@gmail.com>
61 lines
1.3 KiB
Plaintext
61 lines
1.3 KiB
Plaintext
---
|
|
title: "GitHub Actions"
|
|
description: "Run Strix security scans on every pull request"
|
|
---
|
|
|
|
Integrate Strix into your GitHub workflow to catch vulnerabilities before they reach production.
|
|
|
|
## Basic Workflow
|
|
|
|
```yaml .github/workflows/security.yml
|
|
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:
|
|
|
|
| Secret | Description |
|
|
|--------|-------------|
|
|
| `STRIX_LLM` | Model name (e.g., `anthropic/claude-sonnet-4-6`) |
|
|
| `LLM_API_KEY` | API key for your LLM provider |
|
|
|
|
## Exit Codes
|
|
|
|
The workflow fails when vulnerabilities are found:
|
|
|
|
| Code | Result |
|
|
|------|--------|
|
|
| 0 | Pass — No vulnerabilities |
|
|
| 2 | Fail — Vulnerabilities found |
|
|
|
|
## Scan Modes for CI
|
|
|
|
| Mode | Duration | Use Case |
|
|
|------|----------|----------|
|
|
| `quick` | Minutes | Every PR |
|
|
| `standard` | ~30 min | Nightly builds |
|
|
| `deep` | 1-4 hours | Release candidates |
|
|
|
|
<Tip>
|
|
Use `quick` mode for PRs to keep feedback fast. Schedule `deep` scans nightly.
|
|
</Tip>
|