Nixer Documentation
Everything you need to integrate AI security scanning into your workflow — GitHub Action, CLI, REST API, SARIF, and detection rule reference.
New to Nixer? Start with the Quickstart guide — you'll be scanning in under 5 minutes using the GitHub Action or the CLI.
Getting Started
Quickstart
5 minutes from zero to your first scan. GitHub Action or local CLI — your choice.
GitHub Action
Full v1.1 reference — inputs, outputs, sticky PR comments, SARIF upload, permissions.
Configuration & Integration
Configuration
nixer.yml schema — enabled detectors, severity thresholds, path ignores, suppression syntax.CI Recipes
Drop-in YAML for GitHub Actions, GitLab CI, CircleCI, and Jenkins.
Reference
Findings Reference
Every detection rule, severity default, and remediation link. Cross-referenced with the learn curriculum.
REST API
Trigger scans, fetch reports, and query findings. curl, Node.js, and Python snippets.
SARIF Reference
SARIF schema Nixer emits and how to consume it in GitHub Code Scanning.
Detection Rules Catalog
Full public catalog with code examples, breach history, and remediation for every rule.
Score Badges
Embed a live Nixer Score SVG badge in any README. Auto-updated on every re-scan.
External Links
| Resource | Description |
|---|---|
| GitHub Marketplace | Install the Nixer Action directly from GitHub Marketplace |
| npm: nixer | CLI package — npm install -g nixer or use npx nixer |
| npm: @nixer/mcp-server | MCP server for Claude Desktop, Cursor, and Windsurf |
| GitHub: Polsia-Inc/nixer | CLI source code — open for issues and contributions |
| /mcp | MCP server install guide for AI coding tools |