# AGENTS.md

The world's most flexible commerce platform for agents and developers

## Setup

```
yarn install
```

## Commands

```
yarn build         # produce a build
yarn test          # run the test suite, must pass before any commit
yarn lint          # lint
yarn lint:medusa
yarn lint:path
yarn prettier
yarn jest
yarn test:chunk
```

## Layout

- `packages/`          8201 source files
- `www/`               3565 source files
- `integration-tests/` 300 source files
- `scripts/`           27 source files

## Conventions

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

## Gotchas

- `.yarn/releases/yarn-3.2.1.cjs` is 2122KB. 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.