# wavedrom-cli

**Repository Path**: wjztju/wavedrom-cli

## Basic Information

- **Project Name**: wavedrom-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: trunk
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-03
- **Last Updated**: 2021-12-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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 v12+`

```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 --file - --export-pdf 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).