OzzyRMOzzyRMDocs
Installation

Install the package

Add OzzyRM with npm, pnpm, or bun.

Add OzzyRM to your project with your package manager.

Requirements

  • Node.js 18+ (or Bun)
  • A React-based app where you can mount the docs UI (client component, RSC host, or mount())
  • Peer dependency: react / react-dom 19.x
  • At least one schema source: Prisma, Drizzle, or .sql files

Install

Terminal
npm i ozzyrm

Styles are injected automatically. You do not need to import a CSS file.

OzzyRM is one npm package (ozzyrm). Use ozzyrm/react for the client UI, ozzyrm/react/server for server helpers, and ozzyrm/ui for mount().

Next

Continue to Quick start to create a config and mount the UI.

About OzzyRM

Who OzzyRM is for and how the package is organized.

Quick start

Config, mount, and run OzzyRM in a few steps.

On this page

RequirementsInstallNext