# ghidra-cli

A small, dependable command-line interface for read-only Ghidra analysis.
The repository is named `ghidra-cli`; the installed executable is `ghidr`.

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
ghidr doctor
ghidr inspect ./sample
ghidr functions ./sample
ghidr decompile ./sample --name main
```

Each command will identify the sample by its content, reuse compatible cached
analysis, and produce versioned JSON by default. Human-readable presentation is
available explicitly through `--format human`.

## 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.
- [docs/adr/](./docs/adr/) records durable architectural decisions.
- [docs/research/](./docs/research/) records cited prior-art investigations,
  including the Ghidra MCP comparison that informed protocol safeguards and
  the post-version-0.1 roadmap.

## Status

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

## License

Licensed under the [Apache License 2.0](./LICENSE).

Development may use AI assistance. Maintainers remain responsible for reviewing
the resulting design and code, verifying provenance, testing behavior, and
ensuring dependency-license compatibility.