# swirly

> A marble diagram generator.

Latest version **0.22.0** (published 2026-11-19) · MIT license · 0 weekly downloads

## Install

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

Provides the command `swirly`.

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.22.0 |
| Published | 2026-11-19 |
| First published | 2019-09-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 11 |
| Unpacked size | 77.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 125 |
| Author | Tim De Pauw |
| Maintainers | timdp |

## Links

- npm: https://www.npmjs.com/package/swirly
- Repository: https://github.com/timdp/swirly
- Homepage: https://swirly.tmdpw.eu
- Issues: https://github.com/timdp/swirly/issues
- Funding: https://github.com/sponsors/timdp
- npm.io page: https://npm.io/package/swirly

## Dependencies (11)

- [svgo](https://npm.io/package/svgo.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^18.2.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^5.5.0
- [@types/node](https://npm.io/package/@types/node.md) ^22.20.5
- [@swirly/parser](https://npm.io/package/@swirly/parser.md) ^0.22.0
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.21
- [@swirly/renderer-node](https://npm.io/package/@swirly/renderer-node.md) ^0.22.0
- [@swirly/theme-default-dark](https://npm.io/package/@swirly/theme-default-dark.md) ^0.22.0
- [@swirly/theme-default-light](https://npm.io/package/@swirly/theme-default-light.md) ^0.22.0
- [@swirly/rasterization-client](https://npm.io/package/@swirly/rasterization-client.md) ^0.22.0
- [@swirly/rasterization-server](https://npm.io/package/@swirly/rasterization-server.md) ^0.22.0

## Recent versions

- 0.22.0 (latest) — 2026-11-19
- 0.21.0 — 2022-07-03
- 0.20.0 — 2022-06-30
- 0.19.2 — 2022-06-30
- 0.19.1 — 2022-06-30
- 0.19.0 — 2022-06-30
- 0.18.2 — 2022-06-01
- 0.18.1 — 2022-06-01
- 0.18.1-alpha.0 — 2022-05-31
- 0.18.0 — 2022-05-31
- 0.17.6 — 2021-03-23
- 0.17.5 — 2021-02-12
- 0.17.4 — 2021-02-02
- 0.17.3 — 2021-01-29
- 0.17.2 — 2021-01-27
- … 53 more at https://npm.io/package/swirly/versions

## README

# Swirly

![Swirly](https://user-images.githubusercontent.com/201034/82764045-6173da00-9e0c-11ea-9bee-4fb6543d977a.png)

A marble diagram generator.

[![npm][npm-badge]][npm]

[npm-badge]: https://img.shields.io/npm/v/swirly.svg
[npm]: https://www.npmjs.com/package/swirly

## Usage

The `swirly` npm package provides Swirly as a CLI utility. Documentation for
this utility is available [on GitHub](https://github.com/timdp/swirly).

Alternatively, you can also use Swirly in your browser. To do so, hit
[**swirly.tmdpw.eu**](https://swirly.tmdpw.eu/) and start your editing!

## Author

[Tim De Pauw](https://tmdpw.eu)

## License

MIT

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