# AGENTS.md

Shannon is an AI pentester for web applications and APIs. It analyzes your source code, identifies attack vectors, and executes real exploits to prove vulnerabilities before they reach production.

## Setup

```
pnpm install
```

## Commands

```
pnpm build             # produce a build
pnpm check             # lint and type check
pnpm biome
pnpm biome:fix
pnpm clean
pnpm temporal:worker
pnpm temporal:start
```

## Layout

- `apps/` 122 source files

## Conventions

- Tests live alongside the code they cover, following `apps/cli/src/model-spec.ts`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/release-beta.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Copy `.env.example` before running anything that needs configuration.

---

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.