CLI

The ozzyrm binary ships with the package.

npx ozzyrm generate [--config ozzyrm.config.ts]
npx ozzyrm watch    [--config ozzyrm.config.ts]
npx ozzyrm serve    --root <dir> [--port 4173] [--route /]

generate

Reads ozzyrm.config.ts, resolves adapters / unified / scenarios, and writes catalog JSON under output (default ./.ozzyrm).

npx ozzyrm generate
npx ozzyrm generate --config ./config/ozzyrm.config.ts

watch

Watches schema files from your adapters and regenerates on change. Respects config.watch (enabled, debounceMs, generateOnStart, hot).

npx ozzyrm watch

See Watch options and React watch & HMR.

serve

Serves a static docs root with path confinement (rejects .. escapes). Useful for static exports, not required for the React mount APIs.

npx ozzyrm serve --root ./dist/docs --port 4173 --route /

Typical flow

1. Create ozzyrm.config.ts with adapters (and optional unified / scenarios)
2. Run ozzyrm watch while developing
3. Mount the UI with OzzyRMDocsFromConfig, OzzyRMDocs, or mount() after loadCatalog

Next

• Quick start
• Mount in React