# plantuml

> Convert PlantUML diagram text to SVG

Latest version **0.0.2** (published 2022-09-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install plantuml
pnpm add plantuml
yarn add plantuml
bun add plantuml
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-09-11 |
| First published | 2020-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Ægir Örn Símonarson |
| Maintainers | agirorn |
| Keywords | PlantUML, UML, Unified Modeling Language, Modeling, Sequence diagram, Usecase diagram, Class diagram, Activity diagram, Component diagram, State diagram, Object diagram, Deployment diagram, Timing diagram |

## Links

- npm: https://www.npmjs.com/package/plantuml
- Repository: https://github.com/agirorn/plantuml
- Issues: https://github.com/agirorn/plantuml/issues
- npm.io page: https://npm.io/package/plantuml

## Dependencies (2)

- [execa](https://npm.io/package/execa.md) ^4.0.0
- [get-stream](https://npm.io/package/get-stream.md) ^5.1.0

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2022-09-11
- 0.0.1 — 2020-02-05

## README

[![npm version][npm-badge]][npm-link]
[![Build Status][travis-badge]][travis-link]

# plantuml

Convert [PlantUML] diagram text to SVG.

> Using PlantUML Version 1.2022.7

## Installation

```bash
$ npm install plantuml
```

## Dependencies

Requires java and graphviz to be installed on the system.

## Usage

```js
const plantuml = require('plantuml');
const svg = await plantuml(`
  @startuml
  Bob -> Alice : hello
  Alice -> Wonderland: hello
  Wonderland -> next: hello
  next -> Last: hello
  Last -> next: hello
  next -> Wonderland : hello
  Wonderland -> Alice : hello
  Alice -> Bob: hello
  @enduml
`);

require('fs').writeFileSync('image.svg', svg);
```

## License

MIT

[PlantUML]: https://plantuml.com
[npm-badge]: https://badge.fury.io/js/plantuml.svg
[npm-link]: https://badge.fury.io/js/plantuml
[travis-badge]: https://travis-ci.org/agirorn/plantuml.svg?branch=master
[travis-link]: https://travis-ci.org/agirorn/plantuml

---
_Source: https://npm.io/package/plantuml · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._