https://github.com/wavedrom/cli

CLI for WaveDrom
https://github.com/wavedrom/cli

hacktoberfest

Last synced: 2 months ago
JSON representation

CLI for WaveDrom

• Host: GitHub
• URL: https://github.com/wavedrom/cli
• Owner: wavedrom
• License: mit
• Created: 2016-01-16T03:01:57.000Z (about 9 years ago)
• Default Branch: trunk
• Last Pushed: 2024-02-22T18:25:36.000Z (11 months ago)
• Last Synced: 2024-10-29T23:57:10.700Z (3 months ago)
• Topics: hacktoberfest
• Language: JavaScript
• Homepage: https://wavedrom.com
• Size: 334 KB
• Stars: 61
• Watchers: 7
• Forks: 12
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![NPM version](https://img.shields.io/npm/v/wavedrom-cli.svg)](https://www.npmjs.org/package/wavedrom-cli)

[![Linux](https://github.com/wavedrom/cli/actions/workflows/linux.yml/badge.svg)](https://github.com/wavedrom/cli/actions/workflows/linux.yml)

[![MacOS](https://github.com/wavedrom/cli/actions/workflows/macos.yml/badge.svg)](https://github.com/wavedrom/cli/actions/workflows/macos.yml)

[![Windows](https://github.com/wavedrom/cli/actions/workflows/windows.yml/badge.svg)](https://github.com/wavedrom/cli/actions/workflows/windows.yml)

# wavedrom-cli

WaveDrom command-line interface

## Usage

### Install

Requires `nodejs v14+`

```sh

npm i wavedrom-cli -g

```

### Export SVG

```sh

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

```

### Export PNG

```sh

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

```

### Export with Inkscape

[Inkscape](https://inkscape.org) 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:

```sh

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](./LICENSE).