# AGENTS.md

💖🧸 Self hosted, you-owned Grok Companion, a container of souls of waifu, cyber livings to bring them into our worlds, wishing to achieve Neuro-sama's altitude. Capable of realtime voice chat, Minecraft, Factorio playing. Web / macOS / Windows supported.

## 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 postinstall
pnpm dev:docs
pnpm dev:ui
```

## Layout

- `packages/`     1650 source files
- `apps/`         467 source files
- `integrations/` 255 source files
- `server/`       247 source files
- `services/`     189 source files
- `docs/`         72 source files

## Conventions

- Tests live alongside the code they cover, following `apps/stage-pocket/android/app/src/test/java/ai/moeru/airi_pocket/websocket/HostWebSocketBridgeTest.kt`.
- 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/autofix.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.