A command line interface wrapped around viz.js.
Provides a cross-platform way to use core GraphViz features with similar command line syntax.
npm install -g viz.js-cli-wrapper
or locally for your package
npm install --save viz.js-cli-wrapper
The package provides six GraphViz-like executables:
If you chose to install globally, npm should have already made them available on your PATH so you can run them everywhere.
If you need to locate them,
npm bin -g will point you to their location (usually
%APPDATA%/npm on Windows).
If you installed locally, running
npm bin in your package will print their location, usually
The command line interface is very similar to that of GraphViz itself, however, options are limited as viz.js does not support the whole range of GraphViz' features.
The following GraphViz options are currently supported:
-K(with all engines that have corresponding executables available)
-T(with the formats
- input files
For the full help text containing further information, run any of the executables with the
-h flag, e.g.
2- invalid CLI usage
70- failed to read an input file
80- failed to write to the output file
100- rendering error from viz.js
A common use case for GraphViz is generating UML diagrams via PlantUML. As a Java application, PlantUML is nicely portable and runs on all platforms, however, its dependency to GraphViz' dot engine makes the setup on different platforms annoying.
Using viz.js-cli-wrapper, you can easily set it up anywhere. If you installed it globally, depending on your system PlantUML might just locate the dot executable out of the box. In any case, you can tell PlantUML where to find it using the GRAPHVIZ_DOT environment variable or the -graphvizdot CLI switch.
See the Executables section on where to find the viz.js-cli-wrapper executables. On Windows, you need to specify the path to "dot.cmd" including the ending, otherwise PlantUML will not find it.
viz.js-cli-wrapper is MIT-licensed.