# Ebean ORM — AI Agent Index

> Ebean is a Java/Kotlin ORM for SQL databases. Use this file as a router: choose the task bundle, then follow the linked markdown guides.

## Start Here (Agent Onboarding)

- If your tool supports Agent Skills, prefer installing the [ebean-orm skill](https://ebean.io/docs/agents/skills).
- [AGENTS.md template](https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/AGENTS.md): Minimal onboarding template for AI coding agents.
- [Guide index](https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/README.md): Canonical index of Ebean markdown guides for agents.

## Task Bundles

- [llms-setup.txt](https://ebean.io/llms-setup.txt): Install and wire Ebean (dependencies, database config, test container setup).
- [llms-modeling.txt](https://ebean.io/llms-modeling.txt): Entity modeling guidance, including Lombok compatibility.
- [llms-querying.txt](https://ebean.io/llms-querying.txt): Query beans, fetch tuning, and read-only graph guidance.
- [llms-write-transactions.txt](https://ebean.io/llms-write-transactions.txt): Persist/save/update/delete choices and transaction boundaries.
- [llms-testing.txt](https://ebean.io/llms-testing.txt): Ebean testing patterns and helper tools.
- [llms-db-migrations.txt](https://ebean.io/llms-db-migrations.txt): DB migration generation and migration execution workflow.

## Notes for Agents

- Prefer these markdown guides before generating Ebean code: `https://raw.githubusercontent.com/ebean-orm/ebean/HEAD/docs/guides/*.md`
- Ebean needs enhancement configured at build time (Maven/Gradle).
- Load only the bundle needed for the current task to reduce noise and improve retrieval quality.

## Optional

- [llms-full.txt](https://ebean.io/llms-full.txt): Combined fallback context file.