wavedrom
:ocean: Digital timing diagram rendering engine
File Explorer
- ci.yml
- CONTRIBUTING.md
- FUNDING.yml
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- cli.js
- header.js
- svg2js.js
- unpkg.js
- append-save-as-dialog.js
- arc-shape.js
- arcs.js
- arcs.new.js
- char-width.json
- create-element.js
- editor-refresh.js
- eva.js
- find-lane-markers.js
- gen-brick.js
- gen-first-wave-brick.js
- gen-wave-brick.js
- index.js
- insert-svg-template.js
- lane.js
- parse-config.js
- parse-wave-lane.js
- parse-wave-lanes.js
- process-all.js
- rec.js
- render-any.js
- render-arcs.js
- render-gaps.js
- render-groups.js
- render-label.js
- render-lanes.js
- render-marks.js
- render-over-under.js
- render-piece-wise.js
- render-reg.js
- render-signal.js
- render-wave-element.js
- render-wave-form.js
- render-wave-lane.js
- text-width.js
- w3.js
- wave-drom.js
- wave-skin.js
- dark.js
- default.js
- lowkey.js
- narrow.js
- narrower.js
- narrowerer.js
- width.html
- assign.json5
- reg-opivi.json5
- reg-vl.json5
- reg.js
- signal-arcs.json5
- signal-arcs1.json5
- signal-arcs1.svg
- signal-step4.json5
- signal.js
- test-assign.html
- test-dark.html
- test-reg.html
- test-sub-cycle.html
- test.adoc
- test.html
- test.md
- test2.html
- dark.svg
- default.svg
- lowkey.svg
- narrow.svg
- narrower.svg
- narrowerer.svg
- README.md
- svg2json.pl
- WaveDrom.vue
- .gitignore
- eslint.config.js
- LICENSE
- package.json
- README.md
# Installation Guide
nodeSetup Steps
npm install -g wavedrom
Install WaveDrom package globally.
wavedrom --input source.json5 --indent 2 > output.svg
Parse JSON5 source file and generate an SVG file.
Key Commands
npx wavedrom --input source.json5 > output.svg
Temporarily run the package without global installation to generate SVG.
npm install -g wavedrom
Install WaveDrom globally to use it as a CLI tool.
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Command Glossary
Commands referenced in this DOCs, explained below.
npm install
View Details ▼
npm install
Install Node packages.
npm {{[i|install]}}
Install dependencies listed in `package.json`:
npm {{[i|install]}} {{package_name}}@{{version}}
Download a specific version of a package and add it to the list of dependencies in `package.json`:
npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}
Download the latest version of a package and add it to the list of dev dependencies in `package.json`:
npx
View Details ▼
npx
This command is an alias of `npm exec`.
tldr npm exec
View documentation for the original command:
tar
View Details ▼
tar
Archiving utility.
Often combined with a compression method, such as `gzip` or `bzip2`.
tar cf {{path/to/target.tar}} {{path/to/file1 path/to/file2 ...}}
[c]reate an archive and write it to a [f]ile:
tar czf {{path/to/target.tar.gz}} {{path/to/file1 path/to/file2 ...}}
[c]reate a g[z]ipped archive and write it to a [f]ile:
tar czf {{path/to/target.tar.gz}} {{[-C|--directory]}} {{path/to/directory}} .
[c]reate a g[z]ipped (compressed) archive from a directory using relative paths:
script
View Details ▼
script
Record all terminal output to a typescript file.
script
Record a new session to a file named `typescript` in the current directory:
exit
Stop recording:
script {{path/to/session.out}}
Record a new session to a custom filepath: