ghidra-agent-cli

name

ghidra-agent-cli

description

Rust CLI reference for the headless-ghidra pipeline. Covers command syntax, flags, output contract, artifact paths, and workspace layout for all ghidra-agent-cli subcommands. Load when: constructing a ghidra-agent-cli command, interpreting its output, resolving a flag or artifact path question, or debugging CLI behavior. Do not load for P0–P4 workflow sequencing — use the headless-ghidra skill family instead.

ghidra-agent-cli

Description

ghidra-agent-cli is the bundled helper for the Headless Ghidra skill family. It owns the command tree, workspace layout, YAML artifact semantics, output envelope, and runtime behavior for supported Ghidra, Frida, progress, and gate operations.

This skill documents the helper command semantics for agents. It does not define the P0–P4 workflow order, stage routing, or orchestration policy. Those are defined by headless-ghidra/SKILL.md and the per-phase skills. Normal users install and use the skill family; they do not manually install, build, or run this CLI during the workflow.

Prerequisites

• Node.js >= 18
• Local Ghidra installation discoverable by ghidra-agent-cli ghidra discover
• Optional Frida installation for frida * commands

Availability

The helper is installed with the skill family and must remain a sibling of headless-ghidra and the phase skills. If ghidra-agent-cli is unavailable, ask the user to reinstall or refresh the whole skill family rather than installing a separate CLI package inside the target workspace.

Release-managed helper package version: ghidra-agent-cli@1.8.0. This marker is packaging metadata; do not ask users to install it manually during an analysis workflow.

Invocation

ghidra-agent-cli [GLOBAL FLAGS] <COMMAND> [COMMAND FLAGS]

Input

Global flags:

• --format yaml|json|toml — Output format (default: yaml)
• --target <id> — Target selector
• --workspace <path> — Workspace root path
• --config-dir <PATH> — Override config directory
• --data-dir <PATH> — Override data directory
• --state-dir <PATH> — Override state directory
• --cache-dir <PATH> — Override cache directory
• --log-dir <PATH> — Override log directory
• --lock-timeout <SECS> — Lock acquisition timeout in seconds (default: 30)
• --no-wait — Do not wait for lock acquisition
• --help — Show help text

Most commands require --target <id> or an active context set via context use.

Output

Commands emit a structured envelope in the selected format:

status: ok
message: "<summary>"
data: <structured payload>

Errors

Errors are structured and stable:

{
  "code": "E_ERROR",
  "message": "description of what went wrong",
  "source": "main",
  "format": "json"
}

Known codes:

• E_ERROR — General error
• E_GATE_FAILED — Gate check failed
• E_LOCK_TIMEOUT — Lock acquisition timed out

Command Groups

Group	Purpose
workspace	Initialize a target workspace and manage phase state
scope	Manage scope.yaml
functions / callgraph / types / vtables / constants / strings / imports	Manage baseline YAML metadata
third-party	Manage third-party/identified.yaml, explicit no-third-party reviews, and pristine source metadata
runtime	Manage runtime/run-manifest.yaml and runtime/run-records/*.yaml
hotpath	Manage runtime/hotpaths/call-chain.yaml
metadata	Manage P3 metadata YAML such as metadata/renames.yaml and metadata/signatures.yaml
substitute	Manage P4 substitution records under substitution/functions/<fn_id>/
git-check	Validate artifact YAML files are ready for review when a gate asks for it
execution-log	Append and inspect execution records
progress	Compatibility helpers for legacy decompilation progress YAML
gate	Run aggregate gate checks and inspect gate reports
ghidra	Discover Ghidra, import/analyze, export baseline, apply changes, import custom headers/signatures, decompile, rebuild
frida	Device, capture, compare, trace, run, and invoke helpers
inspect	Read-only binary inspection helpers
context	Active context helpers
paths	Show resolved workspace/runtime paths
validate / help	Validation and help surfaces

Workspace Model

ghidra-agent-cli uses this active workspace layout:

targets/<target-id>/
└── ghidra-projects/

artifacts/<target-id>/
├── pipeline-state.yaml
├── scope.yaml
├── intake/
├── baseline/
│   ├── functions.yaml
│   ├── callgraph.yaml
│   ├── types.yaml
│   ├── vtables.yaml
│   ├── constants.yaml
│   ├── strings.yaml
│   └── imports.yaml
├── runtime/
│   ├── project/
│   ├── fixtures/
│   ├── run-manifest.yaml
│   ├── run-records/
│   └── hotpaths/call-chain.yaml
├── third-party/
│   ├── identified.yaml
│   ├── pristine/<library>@<version>/
│   └── compat/<library>@<version>/
├── metadata/
│   ├── renames.yaml
│   ├── signatures.yaml
│   ├── types.yaml
│   ├── constants.yaml
│   ├── strings.yaml
│   └── apply-records/
├── substitution/
│   ├── template/
│   ├── next-batch.yaml
│   └── functions/<fn_id>/
│       ├── capture.yaml
│       └── substitution.yaml
├── gates/
└── scripts/

workspace init creates the base workspace structure and initializes pipeline-state.yaml plus scope.yaml. Later phases populate the remaining artifacts.

Artifact Semantics

Artifact	Meaning
pipeline-state.yaml	Current target, current phase, recorded binary path
scope.yaml	Explicit scope mode and entry list
baseline/*.yaml	Baseline metadata exported from Ghidra or curated through CLI commands
runtime/run-manifest.yaml	P1 reproducible runtime manifest and run-record index
runtime/run-records/*.yaml	P1 concrete executable or harness run observations
runtime/hotpaths/call-chain.yaml	P1 Frida-derived hotpath call-chain priority source
third-party/identified.yaml	Identified libraries, versions, evidence, source paths, pristine paths, and function classifications; libraries: [] records an explicit no-third-party review
third-party/pristine/<library>@<version>/	Unmodified third-party source snapshot that must remain pristine
third-party/compat/<library>@<version>/	Compatibility modifications separate from pristine source
metadata/*.yaml	P3 recovered names, signatures, types, constants, and strings before CLI-mediated Ghidra apply
metadata/apply-records/*.yaml	P3 records for serialized metadata apply attempts
substitution/next-batch.yaml	P4 substitution worklist
substitution/functions/<fn_id>/*.yaml	P4 function fixtures, captures, substitution records, status, and follow-up data
gates/*-report.yaml	Persisted gate check reports

Examples

# Initialize a target
ghidra-agent-cli workspace init --target libfoo --binary ./libfoo.so

# Set scope and inspect state
ghidra-agent-cli --target libfoo scope set --mode full --entries 0x1000,0x2000
ghidra-agent-cli --target libfoo workspace state show

# Export and inspect baseline YAML
ghidra-agent-cli --target libfoo ghidra import
ghidra-agent-cli --target libfoo ghidra auto-analyze
ghidra-agent-cli --target libfoo ghidra export-baseline
ghidra-agent-cli --target libfoo functions list

# Import custom headers and signatures into the current Ghidra program
ghidra-agent-cli --target libfoo ghidra import-types-and-signatures --header ./include/custom_types.h --header ./include/custom_api.h

# Runtime, metadata, substitution, and gate checks
ghidra-agent-cli --target libfoo runtime record --key entrypoint --value 0x401000
ghidra-agent-cli --target libfoo hotpath add --addr 0x401000 --reason runtime
ghidra-agent-cli --target libfoo metadata enrich-function --addr 0x401000 --name main --prototype 'int(void)'
ghidra-agent-cli --target libfoo substitute add --fn-id fn_001 --addr 0x401000 --replacement 'return 0;'
ghidra-agent-cli --target libfoo gate check --phase P1

# Frida helpers
ghidra-agent-cli frida device-list
ghidra-agent-cli frida trace --target ./bin/app --functions open,read

Boundary

• Use this skill to answer: command names, flags, output shape, artifact paths, file semantics, and CLI behavior.
• Do not use this skill as the source of truth for P0–P4 sequencing, stage ownership, or workflow decisions. Those live in the headless-ghidra skill family.