Documentation
Not published yet. The documentation ships with the suite. Until a release exists there is no public repository to link to; this page lists what it contains.
| Document | What it covers |
|---|---|
README.md | Overview, quick start, catalog, conventions, package list and the Status section. |
docs/guide/CLIENTS.md | Attaching a scenario to an agent or client, a first run in five minutes, and a troubleshooting section. |
docs/guide/TOOLS.md | Exact commands, flags, exit codes and offline examples of each tool. |
docs/guide/DETECTION-INTEGRATION.md | Wiring a detection product or an agent to the suite and recording results. |
docs/guide/WORKFLOWS.md | The one-command demo, comparing runs, history, honeytokens, permission modes, repeats, accuracy, coverage, variants. |
docs/guide/AUTOMATION.md | Replaying a saved run, defender notes and a CI check. |
docs/guide/MARKERS.md | Marker strings, tokens, search patterns, artifact locations and loopback ports. |
docs/guide/CATEGORIES.md | The scenarios by category with their mappings. |
docs/TTP-MAP.md | Scenario to MITRE ATLAS, ATT&CK and OWASP mapping with the reasoning. |
docs/scenarios/ | The exact specification of every scenario and foundation package. |
docs/NON-GOALS.md | The capabilities the project will not add. |
docs/guide/RESPONSIBLE-USE.md, DISCLAIMER.md | The usage rules and the disclaimer. Both are reproduced on this site: Responsible use, Legal. |
SECURITY.md, TRADEMARK.md | How to report a problem in the suite, and the name policy. |
Vendor-specific wiring notes in the client guide cite the vendors' own documentation, each fact with a last-verified date. They are compatibility facts only; no vendor endorses or is affiliated with Feintkit.