Exciting release!Introducing "safe npm". Learn more →
Socket
Log inDemoInstall

prisma-uml

Package Overview
Dependencies
6
Maintainers
1
Versions
21
Issues
File Explorer

Advanced tools

prisma-uml

A CLI to transform a Prisma schema to a PlantUML Entity RelationShip Diagram

    1.1.18latest
    GitHub

Version published
Maintainers
1
Weekly downloads
954
decreased by-13.11%

Weekly downloads

Changelog

Source

v1.1.18

1.1.18 (2022-10-18)

Bug Fixes

  • update uuid version (dfae59b)

Readme

Source

Welcome to prisma-uml 👋

A CLI to transform a Prisma schema to a PlantUML Entity RelationShip Diagram

npm npm CircleCI (all branches)

Installation

Using npx

If you don't want to install the CLI but just execute it, you can use it through npx this way

npx prisma-uml --help

Install with npm

You can also install the CLI globally

npm i -g prisma-uml prisma-uml --help

Commands

prisma-uml <path> [options]

Generate a plantUML from a Prisma schema

prisma-uml <path> [--output] [--server] [--file]

Argument

NameDescription
pathPath to Prisma schema.

Options

NameAliasDescriptionType / ChoicesDefault
--output-oOutput of the diagramstring / [text | svg | png | jpg]text
--server-sPlantUML Server URLstringhttps://www.plantuml.com/plantuml
--file-fFilename or File full path to outputstring
Examples

# Output a plantUML Entity Relation Diagram as text prisma-uml ./schema.prisma # Save the diagram into a .plantuml file prisma-uml ./schema.prisma > my-erd.plantuml # Output a diagram as SVG prisma-uml ./schema.prisma --output svg --file my-erd.svg # Output a diagram as PNG prisma-uml ./schema.prisma -o png -f my-erd.png # Use a plantUML custom server to render the image prisma-uml ./schema.prisma --server http://localhost:8080

Image Rendering

Using the official PlantUML server online

PlantUML usually requires to have Java installed or a server to render the images. By default the official online server (https://www.plantuml.com/plantuml) is used to render the images. The plantUML diagram is first compressed then encoded (plantUML encoding) and finally sent to the server to execute the rendering.

Using a local server with Docker

You might want to avoid sending your diagram over the wire for some reason, prisma-uml allows you to specify a custom/local server. You could easily run your own local server using Docker:

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

You server is now available (depending of you Docker installation) at http://localhost:8080. You can then use prisma-uml as follow:

prisma-uml ./schema.prisma --server http://localhost:8080

Demo

asciicast

Incoming changes

Authors

👤 Brendan Stromberger

👤 Yann Renaudin

Show your support

Give a ⭐️ if this project helped you!

Keywords

FAQs

Last updated on 18 Oct 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc