
### Record, share and export your terminal as a animated SVG image.
[](https://github.com/MrMarble/termsvg/actions/workflows/golangci-lint.yml)
[](https://github.com/pre-commit/pre-commit)

[](https://pkg.go.dev/github.com/mrmarble/termsvg)
---
## Overview
TermSVG is an all in one cli tool to record, replay and export your terminal session to svg. It uses the same format as [asciinema](https://asciinema.org) so you can convert asciicast files to SVG or use the asciinema player with a TermSVG recording.
## Installation
### Manually
You can download a pre compiled binary directly from the [releases](https://github.com/mrmarble/termsvg/releases) for your OS/Architecture.
### Go cli
If you already have Go in your system you can use `go install`
```sh
go install github.com/mrmarble/termsvg/cmd/termsvg@latest # or target a specific version @v0.6.0
```
### Install script
I made an [installation script](scripts/install-termsvg.sh) that should download the latest available version corresponding to your OS and architecture. `sudo` is needed to copy the binary to `/usr/local/bin`
```sh
curl -sL https://raw.githubusercontent.com/MrMarble/termsvg/master/scripts/install-termsvg.sh | sudo -E bash -
# or with wget
wget -O - https://raw.githubusercontent.com/MrMarble/termsvg/master/scripts/install-termsvg.sh | sudo -E bash -
```
> [!NOTE]
> Windows binary does not have the `rec` command.
---
## Usage
termsvg is composed of multiple commands, similar to `git`, `docker` or
`asciinema`.
When you run `termsvg` with no arguments help message is displayed, listing
all available commands with their options.
### `rec