# AGENTS.md

Open-source AI job search agent and job finder: scan job boards, score each job 1-5 against your CV before you apply, tailor an ATS-friendly resume and cover letter, get interview prep and a job application tracker. It helps you fill in each application; you press Submit. Runs locally in your AI coding CLI (Claude Code, Codex, OpenCode and more).

## 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/`     589 source files
- `web/`       382 source files
- `providers/` 118 source files
- `dashboard/` 60 source files
- `lib/`       26 source files
- `plugins/`   21 source files

## Conventions

- Tests live alongside the code they cover, following `dashboard/funnel_reload_test.go`.
- 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 1006KB. 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.