# AGENTS.md

Metasploit Framework

## Setup

```
bundle install
```

## 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

- `modules/`  5103 source files
- `lib/`      2311 source files
- `external/` 981 source files
- `spec/`     848 source files
- `data/`     155 source files
- `tools/`    87 source files

## Conventions

- Tests live alongside the code they cover, following `external/serialport/test/miniterm.rb`.
- CI defines what passing means. See `.github/workflows/command_shell_acceptance.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `external/source/exploits/CVE-2015-2426/dll/src/FontData.cpp` is 4793KB. It will not fit comfortably in context, so read it in parts.

---

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.