guardrails-scanner
Advanced tools
AI-powered security scanner that automatically fixes vulnerabilities - SQL injection, XSS, secrets exposure, and more. Not just detection, but intelligent autofix before commit.
AI-powered security scanner for modern development workflows
GuardRails uses advanced AI (Gemini) to detect security vulnerabilities in your code, providing detailed explanations and fix suggestions.
# Install globally
npm install -g @guardrails/scanner
# Or use with npx
npx @guardrails/scanner scan .
# Initialize in your project
guardrails init
npm install -g @guardrails/scanner
npm install --save-dev @guardrails/scanner
npx @guardrails/scanner scan .
# Scan current directory
guardrails scan .
# Scan specific file
guardrails scan src/app.js
# Scan with JSON output
guardrails scan . --format json
# Save report to file
guardrails scan . --output security-report.json
# Fail build on critical issues
guardrails scan . --fail-on-critical
# Generate JSON report for CI
guardrails scan . --format json --output guardrails-report.json
# Install pre-commit hook
guardrails install-hook
# Install hook that blocks commits on critical issues
guardrails install-hook --fail-on-critical
# Initialize GuardRails in your project
guardrails init
This creates:
guardrails.config.json - Configuration filepackage.jsonCreate a guardrails.config.json file:
{
"version": "1.0.0",
"scan": {
"extensions": [".js", ".ts", ".jsx", ".tsx", ".py", ".java", ".go"],
"ignore": ["node_modules/**", ".git/**", "dist/**", "build/**"],
"failOnCritical": true
},
"ci": {
"enabled": true,
"output": "guardrails-report.json"
}
}
name: Security Scan
on: [push, pull_request]
jobs:
security:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: '18'
- name: Install GuardRails
run: npm install -g @guardrails/scanner
- name: Run Security Scan
run: guardrails scan . --fail-on-critical
security_scan:
stage: test
image: node:18
script:
- npm install -g @guardrails/scanner
- guardrails scan . --format json --output guardrails-report.json
artifacts:
reports:
junit: guardrails-report.json
{
"scripts": {
"guardrails:scan": "guardrails scan .",
"guardrails:ci": "guardrails scan . --format json --output guardrails-report.json --fail-on-critical",
"precommit": "guardrails scan . --fail-on-critical"
}
}
.js, .ts, .jsx, .tsx.py.java.go.php.rb.csGuardRails detects:
🛡️ GuardRails Security Report
═══════════════════════════════════════
📊 Security Score: 75/100
📁 Files Scanned: 15
🚨 Total Issues: 3
📋 Issues by Severity:
🔴 Critical: 1
🟡 High: 1
🔵 Medium: 1
🟢 Low: 0
🔍 Detailed Findings:
1. SQL INJECTION
📁 File: src/database.js:25
⚠️ Potential SQL injection detected - string concatenation in query
💡 Fix: Use parameterized queries to prevent SQL injection...
{
"securityScore": 75,
"summary": {
"totalFiles": 15,
"vulnerabilities": 3,
"critical": 1,
"high": 1,
"medium": 1,
"low": 0
},
"findings": [
{
"id": "sql-injection-123",
"type": "SQL_INJECTION",
"severity": "CRITICAL",
"file": "src/database.js",
"line": 25,
"message": "Potential SQL injection detected",
"fix": "Use parameterized queries...",
"analysis": "Detailed AI analysis..."
}
]
}
const GuardRailsScanner = require('@guardrails/scanner');
const scanner = new GuardRailsScanner({
apiKey: process.env.GUARDRAILS_API_KEY,
baseUrl: 'https://api.guardrails.dev'
});
// Scan directory
const results = await scanner.scan('./src');
// Check for critical issues
if (scanner.hasCriticalIssues(results)) {
console.log('Critical security issues found!');
process.exit(1);
}
// Get formatted report
const report = scanner.formatReport(results, 'text');
console.log(report);
guardrails scan <target> [options]
Options:
-f, --format <format> Output format (text, json, table)
-o, --output <file> Output file path
--fail-on-critical Exit with error code if critical issues found
--ignore <patterns> Ignore patterns (comma-separated)
--extensions <exts> File extensions to scan (comma-separated)
--api-key <key> GuardRails API key
--server <url> GuardRails server URL
-h, --help Display help
-V, --version Display version
GuardRails requires a backend server for AI analysis:
# Clone the repository
git clone https://github.com/guardrails/guardrails.git
cd guardrails
# Install dependencies
npm install
# Set up environment
cp env.example .env
# Edit .env with your Gemini API key
# Start the server
npm run dev
GuardRails offers multiple pricing tiers:
We welcome contributions! Please see our Contributing Guide.
MIT License - see LICENSE file.
Made with ❤️ by the GuardRails team
FAQs
AI-powered security scanner that automatically fixes vulnerabilities - SQL injection, XSS, secrets exposure, and more. Not just detection, but intelligent autofix before commit.
The npm package guardrails-scanner receives a total of 3 weekly downloads. As such, guardrails-scanner popularity was classified as not popular.
We found that guardrails-scanner demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A malicious Chrome extension steals newly created MEXC API keys, exfiltrates them to Telegram, and enables full account takeover with trading and withdrawal rights.
Security News
CVE disclosures hit a record 48,185 in 2025, driven largely by vulnerabilities in third-party WordPress plugins.
Security News
Socket CEO Feross Aboukhadijeh joins Insecure Agents to discuss CVE remediation and why supply chain attacks require a different security approach.