Skip to content

Commit

Permalink
docs(readme): add missing export command
Browse files Browse the repository at this point in the history
  • Loading branch information
MrMarble committed Apr 16, 2022
1 parent 265eb1f commit 5862f8a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,25 @@ Available options:
> a terminal of dimensions not smaller than the one used for recording, as
> there's no "transcoding" of control sequences for new terminal size.
### `export`

**Export recorded asciicast to svg.**

This command exports given asciicast (as recorded by `rec` command) to svg.

Exporting from a local file:

```sh
termsvg export -i /path/to/asciicast.cast
```

Available options:

- `-i, --input=<file>` - Asciicast file to export.
- `-o, --output=<file>` - Output svg to be created. Defaults to [input].svg
- `-m, --minify` - Minify svg using [Minify](https://github.com/tdewolff/minify)


## Example

Asciinema recording [inverted pendulum](https://asciinema.org/a/444816)
Expand Down

0 comments on commit 5862f8a

Please sign in to comment.