# AGENTS.md

Node.js/Bun Production Process Manager with a built-in Load Balancer.

## Setup

```
npm install
```

## Commands

```
npm run test            # run the test suite, must pass before any commit
npm run test:unit
npm run test:e2e
npm run test:parallel
npm run test:bpm
npm run test:axon-rpc
npm run test:axon
npm run test:io-agent
```

## Layout

- `test/`     287 source files
- `modules/`  190 source files
- `examples/` 124 source files
- `lib/`      85 source files
- `packager/` 5 source files
- `types/`    1 source file

## Conventions

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

## Gotchas

- `examples/using-pm2-and-transpilers/node.d.ts` is 108KB. It will not fit comfortably in context, so read it in parts.
- 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.