Quick Start
Get up and running with SecurityChecks in under 5 minutes.
Quick Start
Get SecurityChecks running on your project in just a few minutes.
Option 1: GitHub App (Recommended)
The easiest way to use SecurityChecks — zero installation required.
Step 1: Connect Your Repository
- Visit securitychecks.ai
- Click "Connect GitHub"
- Authorize the GitHub App
- Select the repositories you want to protect
Step 2: Open a Pull Request
Once connected, SecurityChecks automatically:
- Runs on every pull request
- Posts findings as inline annotations
- Updates the PR check status
Step 3: Review Findings
You'll see findings directly in your PR:
- P0 Critical — Authorization bypass, SQL injection, etc.
- P1 Important — Missing rate limiting, cache issues, etc.
- P2 Advisory — Best practice recommendations
Each finding includes:
- Evidence from your code
- Attack scenario explanation
- Fix guidance with code examples
Step 4: Dashboard
View all findings, manage baselines, and track trends at securitychecks.ai/dashboard.
Option 2: CLI (Private Beta)
The CLI is available for enterprise customers and approved beta testers.
Prerequisites
- API key from the dashboard
SECURITYCHECKS_CLI_ENABLED=1environment variable
Installation
npm install -g @securitychecks/cli
Setup
# Initialize project configuration
scheck init
# Authenticate with your API key
export SECURITYCHECKS_API_KEY=your_key_here
Run a Scan
scheck run
The CLI sends code artifacts to our cloud API for evaluation. Your source code never leaves your machine — only structural facts are transmitted.
CLI Access
Contact sales@securitychecks.ai for CLI access.
Next Steps
- Managing Findings — Baselines and waivers
- Cloud Dashboard — Team features
- CI/CD Integration — GitHub Actions setup
- CLI Commands — Full CLI reference (beta)