Quickstart

Get your first smart contract security scan running in under 5 minutes.

Prerequisites

• A GitHub repository with Solidity or Vyper contracts

Install the FirePan GitHub App

The fastest way to get started is by installing our GitHub App:

1. Visit github.com/apps/firepan-ai
2. Click Install and select your repositories
3. You'll be redirected to your FirePan dashboard

After installation, select the repositories you want FirePan to analyze. Scans run for the configured GitHub events and can also be started from the dashboard.

Free Scan (No Account)

To try FirePan on a public repository without signing up, use the browser form or call the API:

curl -sS https://api.firepan.com/surface/scan \
  -H "Content-Type: application/json" \
  -d '{"target": "https://github.com/your-org/your-repo"}'

Results usually arrive in under five minutes. Connect the GitHub App when you want private repositories, Probe baselines, or a deeper Audit.

Understanding Your Results

Risk Scores

Score	Level	What it means
70-100	Critical	Major issues found, warrants immediate investigation
50-69	High	Significant findings, moderate concern
25-49	Medium	Some issues worth noting
0-24	Low	Minor findings, typical for battle-tested code

Common Findings

FirePan detects a wide range of vulnerabilities:

• Reentrancy vulnerabilities - External calls before state updates
• Access control issues - Missing or weak authorization
• Integer overflow/underflow - For Solidity < 0.8.0
• Unprotected selfdestruct - Critical self-destruct without access control
• Unchecked external calls - Low-level calls without return validation

Next Steps

• Platform Overview - Learn about FirePan's capabilities
• Scan - Deep dive into quick scanning
• Probe - Investigate a baseline and compare later results
• Audit - Learn about comprehensive audits
• Pricing - Explore our plans

Need Help?

• Dashboard: app.firepan.com
• Support: support@firepan.com