Installation
Quick start
Config, mount, and run OzzyRM in a few steps.
Get from install to a visible docs UI in three steps.
Create a config file
Add ozzyrm.config.ts at the root of your app (or next to your schemas):
import { defineProject, prisma } from "ozzyrm";
export default defineProject({
output: "./.ozzyrm",
schemas: [
prisma({
id: "app",
include: ["./prisma"],
}),
],
});Use drizzle() or sql() adapters the same way when your source is not Prisma.
See Configuration.
Mount the docs UI
Server helper (RSC / Node hosts that can import config):
import config from "../../ozzyrm.config";
import { OzzyRMDocsFromConfig } from "ozzyrm/react/server";
export default async function Page() {
return <OzzyRMDocsFromConfig config={config} />;
}Client component (when you already loaded a catalog):
"use client";
import { OzzyRMDocs } from "ozzyrm/react";
export function Docs({ catalog, defaultSchemaId }) {
return <OzzyRMDocs catalog={catalog} defaultSchemaId={defaultSchemaId} />;
}More patterns: Mount in React.
Run your app
bun run dev
# or: npm run devOpen the route where you mounted OzzyRM and you should see the schema docs UI.
What gets generated
By default OzzyRM writes artifacts under .ozzyrm/ (configurable via output).
Treat that folder like build output: commit or ignore it based on your workflow.
Next
Verify the install, then refine configuration.