# AGENTS.md

Ghidra is a software reverse engineering (SRE) framework

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `Ghidra/`      15957 source files
- `GhidraBuild/` 108 source files
- `GPL/`         69 source files
- `GhidraDocs/`  49 source files
- `docker/`      2 source files

## Conventions

- Tests live alongside the code they cover, following `Ghidra/Debug/Debugger-agent-gdb/src/main/py/tests/EMPTY`.
- CI defines what passing means. See `.github/workflows/build-ghidra-multi-platform-artifact.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `Ghidra/Features/PDB/src/test/java/ghidra/app/util/pdb/Egray864ProgramCreator.java` is 556KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.