Skip to main content

Installation & Setup

Two options:Option 1: Manual Installation
Option 2: DevContainer (Recommended)
See Quick Start for detailed instructions.
Minimum:
  • Python 3.12+
  • 4GB RAM
  • 2GB disk space
  • Claude Code or compatible editor
Recommended (with DevContainer):
  • 8GB RAM
  • 10GB disk space
  • Docker installed
  • Linux x86_64 for full features (rr debugger)
Supported Platforms:
  • Linux (x86_64) - Full support
  • macOS (ARM64/Intel) - Partial support (no rr)
  • Windows (WSL2) - Partial support (no rr)
By default, RAPTOR automatically installs missing tools to streamline usage. This happens when:
  • A command requires a tool that isn’t installed
  • RAPTOR detects missing dependencies
To control installations:
  1. Use the devcontainer (all tools pre-installed)
  2. Pre-install tools manually (see Dependencies)
  3. Review DEPENDENCIES.md before first use
This behavior is documented in README.md as: “Be warned: Unless you use the devcontainer, RAPTOR will automatically install tools without asking.”
Manual installation: Yes, unless using devcontainer.
DevContainer: All tools pre-installed automatically.See Dependencies for complete tool list.
Yes! RAPTOR has a Python CLI for scripting and CI/CD:
However, the interactive Claude Code experience provides better context and decision-making.

LLM Provider Setup

RAPTOR uses LiteLLM for unified LLM integration:Supported providers:
  • Anthropic Claude (recommended)
  • OpenAI GPT-4
  • Google Gemini
  • Ollama (local models)
Configuration:
See LLM Configuration for details.
Yes! RAPTOR supports Ollama for local inference:Setup:
Performance note: Local models work for analysis but may produce lower-quality exploit code compared to frontier models (Claude, GPT-4).Experimental benchmark:
Configure OLLAMA_HOST to point to your remote server:
Performance tuning: Remote Ollama automatically uses longer retry delays (5s vs 2s for local) to account for network latency.
Never disclose remote Ollama server locations in code, comments, or logs (per CLAUDE.md guidelines).
Use LiteLLM YAML configuration:
litellm_config.yaml
See LLM Configuration for complete guide.
RAPTOR includes intelligent quota detection:Rate limit handling:
  1. RAPTOR detects rate limits automatically
  2. Provides provider-specific guidance:
    • Anthropic: Wait time, check usage dashboard
    • OpenAI: Retry with exponential backoff
    • Others: Generic retry advice
  3. Suggests fallback providers if configured
Budget enforcement:
See Cost Management for details.

Cost Management

Depends on LLM provider and scan size:Typical costs (Claude/GPT-4):
  • Quick scan (no exploits): ~$0.10-0.30
  • Full agentic (with exploits): ~$0.50-2.00
  • Per vulnerability exploit: ~$0.03
Free options:
  • Ollama (local inference): FREE
  • Scan-only mode (no LLM): FREE
Cost tracking: RAPTOR logs costs for every LLM call:
Use LiteLLM’s budget enforcement:
Budget exceeded error:
RAPTOR will stop immediately when budget is exceeded.
Cost optimization strategies:
  1. Use scan-only mode (no LLM, free):
  1. Skip exploit generation:
  1. Use local models:
  1. Analyze only high-priority findings: Use adversarial thinking to focus on secrets and high-impact vulnerabilities first.
  2. Set budget limits (see above)
Yes! RAPTOR uses LiteLLM callbacks for real-time cost tracking:Per-request logging:
Budget warnings:
Cost summary at end:

Exploit Generation Quality

Common causes:
  1. Local models: Ollama models often produce non-compilable code. Use Claude or GPT-4 for exploits.
  2. Missing context: Ensure RAPTOR has full codebase context (not just snippets).
  3. Complex vulnerabilities: Some exploits require manual refinement.
Solutions:
  • Use frontier models (Claude Opus, GPT-4)
  • Enable exploit feasibility analysis:
  • Review and manually fix generated code
RAPTOR’s exploit feasibility analysis checks:Accurate checks:
  • Empirical %n verification (tests actual glibc)
  • Null byte constraints from strcpy
  • ROP gadget quality (counts usable gadgets)
  • Input handler bad bytes
  • Full RELRO blocks .fini_array
What it doesn’t replace:
  • Manual exploitation expertise
  • Runtime behavior analysis
  • Complex heap exploitation
Verdict meanings:
  • Likely exploitable: Good primitives, high confidence
  • Difficult: Primitives exist but hard to chain
  • Unlikely: No known path, suggest environment changes
See Exploit Guidance for details.
The exploit feasibility analysis provides next steps:Example output:
Options:
  1. Try suggested mitigations (older environment)
  2. Focus on other vulnerabilities
  3. Use as information leak only
  4. Move on to other targets
RAPTOR always offers next steps, even for “Unlikely” verdicts. Let the user decide how to proceed.
RAPTOR checks ROP feasibility but doesn’t auto-generate full chains:What RAPTOR does:
  • Counts usable ROP gadgets
  • Checks for bad bytes in gadgets
  • Verifies gadget availability
  • Suggests ROP as technique
What RAPTOR doesn’t do:
  • Auto-generate full ROP chains (too complex)
  • Guarantee chain success
Manual ROP: Use tools like ROPgadget or ropper after RAPTOR analysis:

Tool Compatibility

Current status: RAPTOR is designed for Claude Code.Community ports: We welcome contributions to port RAPTOR to:
  • GitHub Copilot
  • Cursor
  • Windsurf
  • Cline
  • Devin
See Contributing to help with ports.
Yes! Use the Python CLI:
GitHub Actions Example
Yes! CodeQL has important licensing restrictions:
CodeQL License: GitHub CodeQL Terms allow free use for:
  • Security research
  • Open source projects
NOT allowed:
  • Commercial use
  • Closed-source commercial products
Alternatives for commercial use:
  1. Use Semgrep only (LGPL 2.1)
  2. Contact GitHub for CodeQL commercial license
  3. Use other SAST tools
See Dependencies for complete license information.
Partial support:Works offline:
  • Static analysis (Semgrep, CodeQL)
  • Binary fuzzing (AFL++)
  • Local Ollama models
Requires internet:
  • Cloud LLM providers (Claude, GPT-4)
  • Tool downloads (if not pre-installed)
  • OSS forensics (GitHub API, BigQuery)
Offline setup:
  1. Use devcontainer (all tools pre-installed)
  2. Install Ollama with local models
  3. Pre-download all dependencies
  4. Run in air-gapped environment
Via WSL2: Yes, with limitations.Setup:
Limitations:
  • No rr debugger (Linux x86_64 only)
  • Some performance overhead
  • Docker Desktop required for devcontainer
Recommended: Use Linux (native or VM) for full features.

Troubleshooting

Solution:
If using devcontainer, rebuild:
Common causes:
  1. CodeQL not in PATH:
  1. Language not detected:
  1. Build required (C/C++): Ensure project can compile:
Causes:
  • Model output truncated
  • Network timeout
  • Ollama slow response
Solutions:
  1. Retry: RAPTOR auto-retries with exponential backoff
  2. Increase timeout (Ollama):
  1. Use frontier models: Claude/GPT-4 have more reliable JSON output than local models.
AFL++ setup issues:
  1. Check system config:
  1. Disable CPU binding (testing):
  1. Verify binary instrumented:
Platform check: rr only works on Linux x86_64.Permissions:
Docker: Ensure --privileged flag:
Fallback: RAPTOR uses GDB on other platforms.

Usage & Workflows

Use /scan when: You want quick findings without exploitsUse /agentic when: You want full autonomous analysis with exploits/patches
Use policy groups:
Yes, with confirmation:
Safety: Dangerous operations (apply patches, git push) require explicit user confirmation.
Use the /crash-analysis command:
What it does:
  1. Clones repository
  2. Builds target with ASAN
  3. Records crash with rr
  4. Analyzes with function tracing
  5. Generates root-cause report
Requirements: rr, gcc/clang, gdb, gcov
/oss-forensics performs evidence-backed forensic investigation for public GitHub repositories.Use cases:
  • Supply chain investigation
  • Malicious commit detection
  • Deleted content recovery
  • Timeline reconstruction
  • Attribution analysis
Example:
Requirements: Google Cloud credentials for BigQuery (GitHub Archive)See OSS Forensics Guide for details.

Getting Help

Documentation

Browse complete documentation

GitHub Issues

Report bugs and request features

Slack Community

Chat with developers on #raptor channel

Quick Start

Get started in 5 minutes

Still Have Questions?