Quick Start
Run your first test or scan in under 5 minutes. Get a unified report combining test results and code analysis.
🤖 Vibe Coding Prompts
Choose your path and copy the prompt to your AI assistant:
Security scan a GitHub repository or live URL
Help me set up Bugrit to scan my code for security issues.
1. First, I need to create an API key at https://bugrit.dev/settings/api-keys
2. Then register my app and run a scan. Here's what I want:
- Repository: [MY_GITHUB_REPO_URL]
- Branch: main
- Run all 150 security and quality modules
3. Use this API call:
POST https://bugrit.com/api/v1/scans
Headers: Authorization: Bearer MY_API_KEY
Body: {
"sourceType": "github",
"repoUrl": "[MY_GITHUB_REPO_URL]",
"branch": "main",
"scanConfig": { "tools": "all" }
}
4. Poll GET /api/v1/scans/{scanId} until status is "completed"
5. Show me the results summary with critical/high/medium/low counts
Please help me run this scan and explain any issues found.✨Works with Claude, ChatGPT, Cursor, Copilot, Cody, and other AI coding assistants
đź’ˇ Why This Matters
Most developers never set up security scanning because it's "too complicated." With Bugrit, you can go from zero to your first security report in under 5 minutes—before you ship code that could get you hacked.
- →Catch issues before launch: Run a scan before your first deploy and know exactly what needs fixing
- →No config required: We auto-detect your stack and run the right tools—no YAML files or setup wizards
- →One report, 150 modules: Instead of setting up ESLint, Prettier, audit-ci, and 22 other modules separately, get everything in one scan
â–¶View Technical Details & Code Examples
⚡ NEW: Real-Time Results
Watch your scan results stream in live as each module completes. No more waiting for all 150 modules to finish!
Use the new Sessions API for streaming results with automatic credit refunds for failed tools.
1. Create an API Key
Navigate to Settings → API Keys and create a new API key. Copy it immediately as it will only be shown once.
2. Register Your Application
Create an application to organize your tests and scans:
curl -X POST https://bugrit.com/api/v1/applications \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "My App",
"platform": "web"
}'Platform options: web, mobile, desktop, hybrid
🔍 3. Scan Code
Submit your code for analysis with 150 modules covering security, quality, dependencies, and more.
Option A: Scan a GitHub Repository
curl -X POST https://bugrit.com/api/v1/scans \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"applicationId": "app-abc123",
"sourceType": "github",
"repoUrl": "https://github.com/yourorg/yourrepo",
"branch": "main"
}'Option B: Scan a Live URL
curl -X POST https://bugrit.com/api/v1/scans \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"applicationId": "app-abc123",
"sourceType": "url",
"targetUrl": "https://your-app.com"
}'Option C: Upload Source Code
curl -X POST https://bugrit.com/api/v1/scans \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "applicationId=app-abc123" \ -F "sourceType=upload" \ -F "file=@./source.zip"
4. Check Status
Poll the scan status until tests and tools have completed:
curl https://bugrit.com/api/v1/scans/scn-xyz789 \ -H "Authorization: Bearer YOUR_API_KEY"
Response (completed):
{
"scan": {
"id": "scn-xyz789",
"status": "completed",
"scanning": {
"toolsTotal": 150,
"toolsCompleted": 150,
"summary": {
"critical": 2,
"high": 5,
"medium": 12,
"low": 28
}
},
"reportId": "rpt-abc123",
"completedAt": "2026-01-20T10:30:47Z"
}
}5. View Your Report
Once complete, view your unified report in the Dashboard or retrieve it via API:
curl https://bugrit.com/api/v1/reports/rpt-abc123 \ -H "Authorization: Bearer YOUR_API_KEY"
The unified report includes:
- Deduplicated findings from all 150 scanning modules
- AI-generated plain English explanations
- Prioritized issues by severity
- Step-by-step remediation guidance