Ghidra CLI
A high-performance Rust CLI for automating Ghidra reverse engineering tasks, designed for both direct usage and AI agent integration (like Claude Code).
Features
- Daemon-only architecture - All operations route through a persistent daemon for consistency
- Auto-start daemon - Import/analyze commands automatically start the daemon
- Fast queries - Sub-second response times with Ghidra kept in memory
- Comprehensive analysis - Functions, symbols, types, strings, cross-references
- Binary patching - Modify bytes, NOP instructions, export patches
- Call graphs - Generate caller/callee graphs, export to DOT format
- Search capabilities - Find strings, bytes, functions, crypto patterns
- Script execution - Run Python/Java scripts, inline or from files
- Batch operations - Execute multiple commands from a file
- Flexible output - Human-readable, JSON, or pretty JSON formats
- Filtering - Powerful expression-based filtering (e.g.,
size > 100)
Architecture
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ CLI Command │────▶│ Daemon (IPC) │────▶│ GhidraBridge │
│ ghidra ... │ │ Unix socket │ │ TCP to Ghidra │
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
▼
┌─────────────────┐
│ bridge.py │
│ (Ghidra Script)│
└─────────────────┘
All commands go through the daemon, which maintains a persistent connection to Ghidra via the bridge script. This provides:
- Consistent state - Single Ghidra process for all operations
- Fast queries - No JVM startup overhead per command
- Auto-start - Daemon starts automatically when needed
Installation
From Source
git clone https://github.com/akiselev/ghidra-cli
cd ghidra-cli
cargo install --path .
Requirements
- Ghidra 10.0+ - Download from ghidra-sre.org
- Java 17+ - Required by Ghidra
- Rust 1.70+ - For building from source
Set the Ghidra installation path:
export GHIDRA_INSTALL_DIR=/path/to/ghidra
# Or configure via CLI:
ghidra config set ghidra_path /path/to/ghidra
Quick Start
# Check installation
ghidra doctor
# Import and analyze a binary (daemon auto-starts)
ghidra quick ./binary
# Or step by step:
ghidra import ./binary --project myproject --program mybinary
ghidra analyze --project myproject --program mybinary
# Query functions (uses running daemon)
ghidra function list
# Decompile a function
ghidra decompile main
# Find interesting strings
ghidra find string "password"
# Get cross-references
ghidra x-ref to 0x401000
# Generate call graph
ghidra graph calls main --depth 3
Commands
Project & Program Management
ghidra project create <name> # Create project
ghidra project list # List projects
ghidra project delete <name> # Delete project
ghidra import <binary> --project <p> # Import binary (auto-starts daemon)
ghidra analyze --project <p> # Run analysis
ghidra quick <binary> # Import + analyze in one step
Function Analysis
ghidra function list # List all functions
ghidra function list --filter "size > 100" # Filter by size
ghidra decompile <name-or-addr> # Decompile function
ghidra disasm <address> --count 20 # Disassemble instructions
Symbols & Types
ghidra symbol list # List symbols
ghidra symbol create <name> <addr> # Create symbol
ghidra symbol rename <old> <new> # Rename symbol
ghidra type list # List data types
ghidra type get <name> # Get type details
Cross-References
ghidra x-ref to <address> # References TO address
ghidra x-ref from <address> # References FROM address
Search
ghidra find string "pattern" # Find strings
ghidra find bytes "90 90 90" # Find byte patterns
ghidra find function "*crypt*" # Find functions by name
ghidra find crypto # Find crypto constants
ghidra find interesting # Find interesting patterns
Call Graphs
ghidra graph calls <func> # Full call graph
ghidra graph callers <func> # Who calls this?
ghidra graph callees <func> # What does this call?
ghidra graph export dot # Export to DOT format
Binary Patching
ghidra patch bytes <addr> "90 90" # Patch bytes
ghidra patch nop <addr> --count 5 # NOP out instructions
ghidra patch export # Export as patch file
Comments
ghidra comment get <address> # Get comment
ghidra comment set <addr> "note" # Set comment
ghidra comment list # List all comments
Scripts
ghidra script list # List available scripts
ghidra script run myscript.py # Run script file
ghidra script python "print(currentProgram)" # Inline Python
Batch Operations
ghidra batch commands.txt # Run commands from file
Statistics
ghidra stats # Program statistics
ghidra summary # Program summary
Daemon Management
The daemon keeps Ghidra loaded in memory. It starts automatically when needed, but you can also control it manually:
# Start daemon with a program loaded
ghidra daemon start --project myproject --program mybinary
# Check daemon status
ghidra daemon status
# All commands use the daemon automatically
ghidra function list # Fast!
ghidra decompile main # Fast!
# Stop daemon
ghidra daemon stop
# Restart with different program
ghidra daemon restart --project myproject --program otherbinary
Output Formats
# Human-readable (default)
ghidra function list
# JSON output
ghidra function list --json
# Pretty JSON
ghidra function list --pretty
# Select specific fields
ghidra function list --fields "name,address,size"
Filtering
Use expressions to filter results:
ghidra function list --filter "size > 100"
ghidra function list --filter "name contains 'main'"
ghidra strings list --filter "length > 20"
AI Agent Integration
Ghidra CLI is designed to work seamlessly with AI coding assistants like Claude Code. The structured output and comprehensive command set make it ideal for automated reverse engineering workflows.
Example workflow with an AI agent:
ghidra quick suspicious.exe- Import, analyze, start daemonghidra find interesting- AI analyzes suspicious patternsghidra decompile <func>- AI examines specific functionsghidra x-ref to <addr>- AI traces data flowghidra patch nop <addr>- AI patches anti-debug codeghidra patch export- Export patched binary
Contributing
Contributions are welcome! Please feel free to submit issues and pull requests.
License
MIT License - See LICENSE for details.