{"id":16549190,"url":"https://github.com/jeysal/viz.js-cli-wrapper","last_synced_at":"2026-04-20T03:32:09.775Z","repository":{"id":10513528,"uuid":"66011071","full_name":"jeysal/viz.js-cli-wrapper","owner":"jeysal","description":"A command line interface wrapped around viz.js.","archived":false,"fork":false,"pushed_at":"2022-04-10T16:39:28.000Z","size":343,"stargazers_count":3,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-08T22:02:21.189Z","etag":null,"topics":["graphviz","node","npm","plantuml"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeysal.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-18T16:01:06.000Z","updated_at":"2023-09-08T17:13:50.000Z","dependencies_parsed_at":"2022-08-07T05:15:51.967Z","dependency_job_id":null,"html_url":"https://github.com/jeysal/viz.js-cli-wrapper","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/jeysal/viz.js-cli-wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeysal%2Fviz.js-cli-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeysal%2Fviz.js-cli-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeysal%2Fviz.js-cli-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeysal%2Fviz.js-cli-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeysal","download_url":"https://codeload.github.com/jeysal/viz.js-cli-wrapper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeysal%2Fviz.js-cli-wrapper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265876915,"owners_count":23842956,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphviz","node","npm","plantuml"],"created_at":"2024-10-11T19:28:33.928Z","updated_at":"2026-04-20T03:32:04.749Z","avatar_url":"https://github.com/jeysal.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# viz.js-cli-wrapper\n\n[![build status](https://img.shields.io/travis/jeysal/viz.js-cli-wrapper.svg?style=flat-square)](https://travis-ci.org/jeysal/viz.js-cli-wrapper)\n[![AppVeyor build status](https://img.shields.io/appveyor/ci/jeysal/viz-js-cli-wrapper.svg?style=flat-square\u0026label=windows+build)](https://ci.appveyor.com/project/jeysal/viz-js-cli-wrapper)\n[![code coverage](https://img.shields.io/codecov/c/github/jeysal/viz.js-cli-wrapper.svg?style=flat-square)](https://codecov.io/gh/jeysal/viz.js-cli-wrapper)\n\n[![npm package](https://img.shields.io/npm/v/viz.js-cli-wrapper.svg?style=flat-square)](https://www.npmjs.com/package/viz.js-cli-wrapper)\n[![license](https://img.shields.io/github/license/jeysal/viz.js-cli-wrapper.svg?style=flat-square)](https://github.com/jeysal/viz.js-cli-wrapper/blob/master/LICENSE)\n\nA command line interface wrapped around [viz.js](https://github.com/mdaines/viz.js).\n\nProvides a cross-platform way to use core [GraphViz](http://www.graphviz.org/) features with similar command line syntax.\n\n## Installation\n\n### npm\n\nYou can install it using [Node.js](https://nodejs.org/) version 5 or higher and [npm](https://www.npmjs.com/), globally on your system\n\n    npm install -g viz.js-cli-wrapper\n\nor locally for your package\n\n    npm install --save viz.js-cli-wrapper\n\n## Usage\n\n### Executables\n\nThe package provides six GraphViz-like executables:  \n* `circo`\n* `dot`\n* `fdp`\n* `neato`\n* `osage`\n* `twopi`\n\nIf you chose to install globally, npm should have already made them available on your PATH so you can run them everywhere.  \nIf you need to locate them, `npm bin -g` will point you to their location (usually `/usr/bin`, or `%APPDATA%/npm` on Windows).\n\nIf you installed locally, running `npm bin` in your package will print their location, usually `node_modules/.bin`.\n\n### Command-line interface\n\nThe command line interface is very similar to that of GraphViz itself, however,\noptions are limited as viz.js does not support the whole range of GraphViz' features.\n\nThe following GraphViz options are currently supported:\n* `-K` (with all engines that have corresponding [executables](https://github.com/jeysal/viz.js-cli-wrapper#executables) available)\n* `-T` (with the formats `svg`, `xdot`, `plain`, `ps` and `json`)\n* `-V`\n* `-o`\n* input files\n\nFor the full help text containing further information, run any of the executables with the `-h` flag, e.g. `dot -h`.\n\n### Exit codes\n\n* `2` - invalid CLI usage\n* `70` - failed to read an input file\n* `80` - failed to write to the output file\n* `100` - rendering error from viz.js\n\n## PlantUML\n\nA common use case for GraphViz is generating UML diagrams via [PlantUML](http://plantuml.com).\nAs a Java application, PlantUML is nicely portable and runs on all platforms, however,\nits dependency to GraphViz' dot engine makes the setup on different platforms annoying.\n\nUsing viz.js-cli-wrapper, you can easily set it up anywhere. If you installed it globally,\ndepending on your system PlantUML might just locate the dot executable out of the box.\nIn any case, you can [tell PlantUML where to find it](http://plantuml.com/command_line.html)\nusing the GRAPHVIZ_DOT environment variable or the -graphvizdot CLI switch.\n\nSee the [Executables section](#executables) on where to find the viz.js-cli-wrapper executables.\nOn Windows, you need to specify the path to \"dot.cmd\" including the ending, otherwise PlantUML will not find it.\n\n## Credits\n\nA huge thanks to [Mike Daines](https://github.com/mdaines) for making GraphViz to some extent portable with [viz.js](https://github.com/mdaines/viz.js)!\n\n## License\n\nviz.js-cli-wrapper is [MIT-licensed](https://github.com/jeysal/viz.js-cli-wrapper/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeysal%2Fviz.js-cli-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeysal%2Fviz.js-cli-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeysal%2Fviz.js-cli-wrapper/lists"}