Quick Start

Run your first security scan in seconds.

1. Basic Scan

Navigate to your React Native or Expo project directory and run:

bash
rnsec scan

This command automatically:

  • Discovers all relevant files in your project
  • Applies 68+ security rules
  • Generates both HTML and JSON reports
  • Displays a summary in the console

2. View Results

The scan generates two reports by default:

bash
# HTML Report (interactive dashboard)
open rnsec-report.html          # macOS
start rnsec-report.html         # Windows
xdg-open rnsec-report.html      # Linux

# JSON Report (machine-readable)
cat rnsec-report.json

3. Understanding Results

Each finding includes:

Rule ID:Unique identifier for the security issue
Description:What was detected
Severity:HIGH (🔴), MEDIUM (🟠), or LOW (🟡)
File Path:Exact location of the issue
Line Number:Specific line with the vulnerability
Code Snippet:Context around the issue
Reason:Why this is a security concern
Suggestion:How to fix it

Common Examples

bash
# Scan current directory with default reports
rnsec scan

# Scan specific project
rnsec scan --path /Users/dev/my-react-native-app

# Custom filenames for both reports
rnsec scan --html my-report.html --output data.json

# CI/CD mode (silent, JSON only)
rnsec scan --output security-results.json --silent

# Console JSON output only (no files)
rnsec scan --json
© 2025 rnsec • Open source security