# AGENTS.md

Next-generation ORM for Node.js & TypeScript | PostgreSQL, MySQL, MariaDB, SQL Server, SQLite, MongoDB and CockroachDB

## Setup

```
pnpm install
```

## Commands

```
pnpm dev           # run locally
pnpm build         # produce a build
pnpm test          # run the test suite, must pass before any commit
pnpm typecheck     # type check without emitting
pnpm lint          # lint
pnpm format        # format
pnpm build:agent
pnpm dev:all
```

## Layout

- `packages/`       2655 source files
- `test/`           1062 source files
- `examples/`       336 source files
- `scripts/`        71 source files
- `apps/`           27 source files
- `skills-contrib/` 18 source files

## Conventions

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

## Gotchas

- `packages/3-extensions/supabase/src/contract/contract.d.ts` is 358KB. 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.