# ghidra-cli

A small, dependable command-line interface for read-only Ghidra analysis.

The project is currently in its design phase. Its first objective is to make
common reverse-engineering questions easy to ask without exposing Ghidra
project management, JVM lifecycle, or scripting details to the user.

Proposed usage:

```console
ghidra-cli doctor
ghidra-cli inspect ./sample
ghidra-cli functions ./sample
ghidra-cli decompile ./sample main
```

Each command will identify the sample by its content, reuse compatible cached
analysis, and produce human-readable or versioned JSON output.

## Documents

- [PRD.md](./PRD.md) defines the product requirements and initial delivery
  scope.
- [CONTEXT.md](./CONTEXT.md) defines the domain language used throughout the
  project.

## Status

Documentation first. There is intentionally no Rust crate yet. Implementation
begins after the initial requirements and interface are reviewed.

## License

No license has been selected yet. Until one is added, all rights are reserved.