# AGENTS.md

The Open-Source Multimodal AI Agent Stack: Connecting Cutting-Edge AI Models and Agent Infra

## Setup

```
pnpm install
```

## Commands

```
pnpm test          # run the test suite, must pass before any commit
pnpm lint          # lint
pnpm format        # format
pnpm commit
pnpm bootstrap
pnpm dev:ui-tars
pnpm test:bench
pnpm coverage
```

## Layout

- `multimodal/` 934 source files
- `packages/`   307 source files
- `apps/`       164 source files
- `infra/`      31 source files
- `examples/`   20 source files
- `scripts/`    4 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/agent_tars_test.yml`.
- 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_tars_test.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- 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.