Introduction
About OzzyRM
Who OzzyRM is for and how the package is organized.
OzzyRM is for teams that already keep schemas in code and want documentation that stays in sync.
The idea
Install one package, define a config, mount a React component, and ship schema docs your team will actually use. No extra CSS pipeline and no hand-maintained docs site for every model change.
Who it is for
- Teams using Prisma, Drizzle, or SQL (or a mix)
- React-based apps (Vite, Next.js, Remix, custom RSC, or client-only mounts)
- Developers who want ERD, search, scenarios, and field docs next to the product
Package surface
| Import | Purpose |
|---|---|
ozzyrm | Config helpers: defineProject, prisma, drizzle, sql, loadCatalog |
ozzyrm/react | Client docs component (OzzyRMDocs) |
ozzyrm/react/server | Server helper (OzzyRMDocsFromConfig) for RSC / Node hosts |
ozzyrm/ui | mount() and lower-level UI building blocks |
Trust model
Config import is high trust. Treat ozzyrm.config.ts like application code. See Security options.
Next
Go to Installation to add the package.