Quick Start
Go from zero to your first security scan in under 5 minutes.
1. Initialize a Project
bash
netinject init --name my-apiThis creates netinject.toml with a full configuration template. Edit it with your target URL:
toml
[project]
name = "my-api"
target = "https://api.staging.example.com"2. Check Your Tools
bash
netinject checkMake sure at least httpx and nuclei are available.
3. Run a Quick Scan
Single-target vulnerability scan:
bash
netinject scan --target https://api.staging.example.com4. Run a Recon
Discover live endpoints and technologies:
bash
netinject recon --target https://api.staging.example.com5. Run a Full Pipeline
Execute a multi-step pipeline (recon then scan):
bash
netinject run --target https://api.staging.example.com --pipeline full-api-scanPreview what would execute without actually running anything:
bash
netinject run --target https://api.staging.example.com --dry-run6. View Sessions
Every run is recorded as a session:
bash
netinject sessions list7. With an OpenAPI Spec
For spec-driven testing, point to your OpenAPI file:
bash
netinject scan --target https://api.example.com --spec ./openapi.yamlOutput Formats
All commands support multiple output formats:
bash
# Terminal table (default)
netinject scan --target https://example.com
# JSON Lines (for piping)
netinject scan --target https://example.com --format jsonl
# Markdown report
netinject scan --target https://example.com --format markdown --output report.md
# SARIF (for GitHub Advanced Security)
netinject scan --target https://example.com --format sarif --output findings.sarif