Skip to content

Commit 0dcc595

Browse files
committed
docs: highlight CLI tool in README
1 parent 584a6ad commit 0dcc595

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ GhydraMCP is a powerful bridge between [Ghidra](https://ghidra-sre.org/) and AI
1414

1515
## Overview
1616

17-
GhydraMCP v2.2.0 integrates three key components:
17+
GhydraMCP v2.2.0 integrates four key components:
1818

1919
1. **Modular Ghidra Plugin**: Exposes Ghidra's powerful reverse engineering capabilities through a HATEOAS-driven REST API
2020
2. **MCP Bridge**: A Python script that translates MCP requests into API calls with comprehensive type checking
21-
3. **Multi-instance Architecture**: Connect multiple Ghidra instances to analyze different binaries simultaneously
21+
3. **CLI Tool (`ghydra`)**: A standalone command-line interface for direct interaction with Ghidra — human-readable tables, syntax highlighting, and `--json` mode for scripting
22+
4. **Multi-instance Architecture**: Connect multiple Ghidra instances to analyze different binaries simultaneously
2223

2324
This architecture enables AI assistants like Claude to seamlessly:
2425
- Decompile and analyze binary code with customizable output formats
@@ -145,6 +146,32 @@ Video Installation Guide:
145146
146147
https://github.com/user-attachments/assets/75f0c176-6da1-48dc-ad96-c182eb4648c3
147148
149+
## CLI Tool
150+
151+
GhydraMCP includes `ghydra`, a command-line tool for interacting with Ghidra directly from the terminal. It works standalone — no MCP client needed.
152+
153+
```bash
154+
# Install
155+
pip install -e .
156+
157+
# List running Ghidra instances
158+
ghydra instances list
159+
160+
# Decompile a function
161+
ghydra functions decompile --name main
162+
163+
# List strings matching a pattern
164+
ghydra data list-strings --filter "password"
165+
166+
# Read memory as hex dump
167+
ghydra memory read --address 0x401000 --length 64
168+
169+
# JSON output for scripting and piping
170+
ghydra --json functions list | jq '.result[].name'
171+
```
172+
173+
All commands support `--host`, `--port`, `--json`, and `--no-color` flags. See [GHYDRA_CLI.md](GHYDRA_CLI.md) for the full reference.
174+
148175
## MCP Clients
149176

150177
GhydraMCP works with any MCP-compatible client using **stdio transport**. It has been tested and confirmed working with:

0 commit comments

Comments
 (0)