wavedrom-cli

library3.2.0jsnpmunverified

WaveDrom command-line interface for converting digital timing diagrams defined in JSON5/JS object notation into SVG or PNG images. Current stable version is 3.2.0, requiring Node.js >=12 (recommended v14+). It supports rendering signal groupings and outputs SVG natively; PNG export uses the native SVG renderer. Unmaintained for some time (last significant release v0.3.x), with breaking changes from prior versions that relied on PhantomJS. Key differentiator: enables programmatic and CI-based generation of timing diagrams without a browser.

devops serialization

npm install wavedrom-cli

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · WAVEDROM-CLI

wavedrom-cli

devopsjavascriptv3.2.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

none (CLI only)

✓ npx wavedrom-cli -i input.json5 -s output.svg

✗ npx wavedrom-cli -i input.js -s output.png

This is a CLI tool, not a library. Use npx or global install.

Create a timing diagram from a JSON5 source file and export to SVG using wavedrom-cli.

mkdir wavedrom-example && cd wavedrom-example cat > timing.json5 << 'EOF' { signal: [ { name: "clk", wave: "p.....|" }, { name: "data", wave: "x...345x|" }, { name: "addr", wave: "x...2x|" } ] } EOF npx wavedrom-cli -i timing.json5 -s timing.svg

wavedrom --version

Debug

Known issues

gotchaNode.js version: v14+ required. Lower versions may fail with SyntaxError or missing features.

fix

Upgrade Node.js to v14 or later. Use nvm or similar.

affects: <3.0.0

breakingPhantomJS-based versions (<=0.2.0) are completely different and incompatible with the current CLI. Do not mix.

fix

Uninstall PhantomJS and use the npm package directly.

affects: <=0.2.0

deprecatedThe --png option uses native SVG-to-PNG conversion which may produce low-quality output. Consider using Inkscape for PNG export.

fix

Pipe SVG output to Inkscape: `wavedrom-cli -i input.json5 | inkscape -p --export-filename=output.png`

affects: >=3.0.0

Errors

Common errors & fixes

Error: Cannot find module 'wavedrom-cli'

Global install not found or npx not used.

fix

Install globally with `npm i -g wavedrom-cli` or use `npx wavedrom-cli`.

SyntaxError: Unexpected token '.'

JSON5 file contains JavaScript syntax that is not valid JSON5.

fix

Use valid JSON5 (e.g., keys unquoted allowed, but no trailing commas).

Upgrade

Version history

3.2.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

16 hits · last 30 days

node

Bingbot

OpenAI (training)

Resources

githubhttps://github.com/wavedrom/cli ↗

packagehttps://www.npmjs.com/package/wavedrom-cli ↗

homepagehttps://wavedrom.com ↗