# AGENTS.md

Open-source AI penetration testing tool to find and fix your app’s vulnerabilities.

## Setup

```
uv sync
```

## Commands

```
make help
make install
make dev-install
make setup-dev
make format        # format
make lint          # lint
```

## Layout

- `strix/`      227 source files
- `tests/`      80 source files
- `scripts/`    4 source files
- `containers/` 1 source file

## Conventions

- Tests live alongside the code they cover, following `strix/interface/tui/internal/app/client_test.go`.
- CI defines what passing means. See `.github/workflows/build-release.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `strix/interface/viewer/static/assets/index-C9c1WbvP.js` is 947KB. 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.