# AGENTS.md

The open-source app everyone uses to manage agents at work

## 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 postinstall
pnpm preflight:workspace-links
pnpm dev:watch
pnpm dev:once
```

## Layout

- `ui/`       1393 source files
- `packages/` 1141 source files
- `server/`   974 source files
- `cli/`      160 source files
- `scripts/`  131 source files
- `tests/`    31 source files

## Conventions

- Tests live alongside the code they cover, following `.agents/skills/company-creator/references/companies-spec.md`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/agent-runtime-images.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `server/src/services/heartbeat.ts` is 755KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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.