-
Notifications
You must be signed in to change notification settings - Fork 0
Quick Start
github-actions[bot] edited this page May 28, 2026
·
1 revision
Get started with DomainRaptor in minutes! This guide will walk you through your first reconnaissance.
Discover all assets for a domain:
domainraptor discover -T example.comThis will:
- Find subdomains from multiple sources
- Enumerate DNS records
- Discover SSL certificates
- Perform WHOIS lookup
╭─────────────────── Scan Summary ───────────────────╮
│ Target: example.com │
│ Type: discover │
│ Status: completed │
│ Duration: 45.2s │
│ │
│ Findings: │
│ • Assets: 24 │
│ • Services: 4 │
│ • Certificates: 12 │
│ • Vulnerabilities: 0 │
│ • Config Issues: 0 │
╰────────────────────────────────────────────────────╯
Complete target assessment from discovery to reporting:
# Step 1: Discover assets
domainraptor discover -T example.com --subdomains --dns --ports --whois
# Step 2: Assess security configuration
domainraptor assess config example.com
# Step 3: Check for vulnerabilities
domainraptor assess vulns example.com
# Step 4: Generate report
domainraptor report generate example.com -f html -o example_report.htmlFast security posture assessment:
domainraptor -m quick assess config example.comThorough investigation with all sources:
domainraptor -m deep discover -T example.com --ports --recursiveSet up automated monitoring:
# Add target to watch list
domainraptor watch add example.com --interval 24h
# View monitored targets
domainraptor watch list
# Run checks manually
domainraptor watch runThese options work with any command:
| Option | Short | Description |
|---|---|---|
--version |
-v |
Show version |
--verbose |
-V |
Enable verbose output |
--debug |
Enable debug mode | |
--config |
-c |
Custom config file |
--mode |
-m |
Scan mode: quick, standard, deep, stealth |
--format |
-f |
Output format: table, json, csv, yaml |
--output |
-o |
Output file path |
--free-only |
Use only free sources | |
--no-color |
Disable colored output | |
--no-banner |
Hide the banner |
# JSON output to file
domainraptor -f json -o results.json discover -T example.com
# Quick mode without banner
domainraptor --no-banner -m quick discover -T example.com
# Deep scan with verbose output
domainraptor -V -m deep discover -T example.com
# Free sources only (no API keys needed)
domainraptor --free-only discover -T example.comHuman-readable tables in the terminal:
domainraptor discover -T example.comMachine-readable format:
domainraptor -f json discover -T example.com
domainraptor -f json -o results.json discover -T example.comdomainraptor -f yaml discover -T example.comdomainraptor -f csv -o assets.csv discover -T example.comAlways begin by discovering the attack surface:
domainraptor discover -T example.com| Mode | Use Case | Speed |
|---|---|---|
quick |
Initial triage | Fast |
standard |
Regular assessments | Medium |
deep |
Thorough investigation | Slow |
stealth |
Low-profile scanning | Varies |
Always save results to the database for comparison:
domainraptor discover -T example.com --save # DefaultCreate professional reports for stakeholders:
domainraptor report generate example.com -f html -o report.html --remediationSet up monitoring for important targets:
domainraptor watch add example.com --interval 6h# General help
domainraptor --help
# Command-specific help
domainraptor discover --help
domainraptor assess config --help
domainraptor report generate --help# List all scans
domainraptor db list
# Show scan details
domainraptor db show 1
# Database statistics
domainraptor db stats← Installation | Next: Configuration →
DomainRaptor v0.2.0 | GitHub | Report Issue | MIT License