# llms.txt

> Unreal ORM: A type-safe ORM for SurrealDB.

## Documentation

- [Getting Started](https://unreal-orm.jimpex.dev/getting-started/readme/): Quickstart, installation, and onboarding.
- [Tutorial](https://unreal-orm.jimpex.dev/guides/unreal-orm-tutorial/): A step-by-step guide to building with Unreal ORM.
- [Cookbook](https://unreal-orm.jimpex.dev/guides/cookbook/): Common patterns and recipes.
- [Using with AI](https://unreal-orm.jimpex.dev/guides/ai-usage/): How to leverage AI tools with Unreal ORM.
- [Capabilities](https://unreal-orm.jimpex.dev/getting-started/capabilities/): Supported SurrealDB features.

## Guides

- [Migrations](https://unreal-orm.jimpex.dev/guides/migrations/): How to handle schema changes.
- [Security & Permissions](https://unreal-orm.jimpex.dev/guides/security-permissions/): Managing access control.
- [Testing](https://unreal-orm.jimpex.dev/guides/testing/): Strategies for testing your ORM models.
- [Graph Relations](https://unreal-orm.jimpex.dev/guides/graph-relations/): Working with SurrealDB's graph features.

## API Reference

- [API Home](https://unreal-orm.jimpex.dev/api/): Full API documentation.
- [Functions](https://unreal-orm.jimpex.dev/api/functions/): Core ORM functions.
- [Interfaces](https://unreal-orm.jimpex.dev/api/interfaces/): Type definitions and interfaces.

## Contributing

- [Design Principles](https://unreal-orm.jimpex.dev/contributing/design-principles/): Project philosophy.
- [Contributing Guide](https://unreal-orm.jimpex.dev/contributing/guide/): Code style and PR process.