Skip to content

wavedrom/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPM version Linux MacOS Windows

wavedrom-cli

WaveDrom command-line interface

Usage

Install

Requires nodejs v14+

npm i wavedrom-cli -g

Export SVG

wavedrom-cli -i mywave.json5 -s mywave.svg

Export PNG

wavedrom-cli -i mywave.json5 -p mywave.png

Export with Inkscape

Inkscape is awesome SVG editor that can be used to convert SVG to many other formats: PDF, PS, EPS, EMF, WMF, PNG. etc. It can be chained with wavedrom-cli to output those formats. Here is an example:

wavedrom-cli -i mywave.json5 | inkscape -p --export-filename=mywave.pdf

Options

  --input, -i  path to the source                                     [required]
  --svg, -s    path to the generated SVG
  --png, -p    path to the generated PNG
  --version    Show version number                                     [boolean]
  --help       Show help                                               [boolean]

License

MIT LICENSE.