# Using with AI

> What to give a coding agent or a chat so it writes effect-cqrs code that compiles.

effect-cqrs is young and built on Effect 4, so a model’s training data knows little about either. Give it the documentation instead.

## A guide for coding agents

The package ships `LLMS.md`, a short guide to the modules, the patterns to follow, the mistakes to avoid and how to test. Point your agent at it from `AGENTS.md` or `CLAUDE.md`:

```md
Before writing code that uses effect-cqrs, read node_modules/effect-cqrs/LLMS.md.
```

It is also [on GitHub](https://github.com/davidnussio/effect-cqrs/blob/main/LLMS.md). Effect has [its own guide](https://github.com/Effect-TS/effect/blob/main/LLMS.md) for the code around it.

## The documentation as text

The site follows the [llms.txt](https://llmstxt.org/) convention:

| File                                | What it holds                                                               |
| ----------------------------------- | --------------------------------------------------------------------------- |
| [`llms.txt`](https://effect-cqrs.dambox.ch/llms.txt)             | An index of the files below                                                 |
| [`llms-full.txt`](https://effect-cqrs.dambox.ch/llms-full.txt)   | Every page, the API reference included, as one Markdown file                |
| [`llms-small.txt`](https://effect-cqrs.dambox.ch/llms-small.txt) | The guides without asides or the API reference, for smaller context windows |

Each page is also served as Markdown: replace the trailing slash of its URL with `.md`, as in [`guides/aggregates.md`](https://effect-cqrs.dambox.ch/guides/aggregates.md). The button under each page title copies that Markdown, and its menu opens the page in Claude or ChatGPT.