# AGENTS.md

Open-source AI job search: scan job portals, evaluate listings into a structured A-H report with a global 1-5 score, tailor your CV, track applications — runs locally in your AI coding CLI (Claude Code, Codex, OpenCode, Antigravity…)

## Setup

```
npm install
```

## Commands

```
npm run lint          # lint
npm run doctor
npm run or
npm run or:scan
npm run or:pipeline
npm run or:eval
npm run or:apply
npm run verify
```

## Layout

- `tests/`     224 source files
- `web/`       209 source files
- `providers/` 88 source files
- `dashboard/` 42 source files
- `plugins/`   13 source files
- `lib/`       10 source files

## Conventions

- Tests live alongside the code they cover, following `company-history.test.mjs`.
- CI defines what passing means. See `.github/workflows/auto-triage-scan-output.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `test-all.mjs` is 883KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.
- 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.