convex-viz: Generate Interactive ER Diagrams from Convex Schemas

Hi all,

I’ve put together a tool called convex-viz for visualizing Convex database schemas as interactive Mermaid ER diagrams.

Usage:
- To start the live server and view your schema in the browser (auto-updates on changes):
  npx convex-viz <schema-file-path>

This opens http://localhost:3418 in your browser. If you don’t specify a schema file, it defaults to convex/schema.ts.

- To print the Mermaid diagram to your terminal (for docs or Mermaid editors):
  npx convex-viz <schema-file-path> --print-diagram


- For more options:
  npx convex-viz --help


You can also install globally with npm install -g convex-viz.

Repo: https://github.com/jlwbr/convex-viz

Let me know if you have any questions or feedback.
GitHub
Contribute to jlwbr/convex-viz development by creating an account on GitHub.
Was this page helpful?