# AGENTS.md

Your Personal AI Assistant; easy to install, deploy on your own machine or on the cloud; supports multiple chat apps with easily extensible capabilities.

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make test               # run the test suite, must pass before any commit
make test-unit
make test-contract
make test-integration
make coverage-full
make check-contracts
```

## Layout

- `console/` 927 source files
- `src/`     926 source files
- `plugins/` 700 source files
- `tests/`   649 source files
- `website/` 93 source files
- `e2e/`     79 source files

## Conventions

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

## Gotchas

- `src/qwenpaw/agents/context/visual_compression/assets/atlas-gray.ts` is 3998KB. 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.