docs: define v0.1 product and architecture contract

This commit is contained in:
hermes 2026-07-28 18:21:19 +00:00
commit c4fb0c6a01
12 changed files with 2130 additions and 64 deletions

View file

@ -1,6 +1,7 @@
# 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
@ -9,14 +10,15 @@ 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
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 human-readable or versioned JSON output.
analysis, and produce versioned JSON by default. Human-readable presentation is
available explicitly through `--format human`.
## Documents
@ -24,6 +26,10 @@ analysis, and produce human-readable or versioned JSON output.
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
@ -32,5 +38,8 @@ begins after the initial requirements and interface are reviewed.
## License
No license has been selected yet. Until one is added, all rights are reserved.
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.