2 |

3 |
4 | ### Record, share and export your terminal as a animated SVG image.
5 |
6 |
7 |
8 |
9 |
10 |
11 | [](https://github.com/MrMarble/termsvg/actions/workflows/golangci-lint.yml)
12 | [](https://github.com/pre-commit/pre-commit)
13 | 
14 | [](https://pkg.go.dev/github.com/mrmarble/termsvg)
15 |
16 |
17 |
18 | ---
19 |
20 | ## Overview
21 |
22 | 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.
23 |
24 | ## Installation
25 |
26 | ### Manually
27 |
28 | You can download a pre compiled binary directly from the [releases](https://github.com/mrmarble/termsvg/releases) for your OS/Architecture.
29 |
30 | ### Go cli
31 |
32 | If you already have Go in your system you can use `go install`
33 |
34 | ```sh
35 | go install github.com/mrmarble/termsvg/cmd/termsvg@latest # or target a specific version @v0.6.0
36 | ```
37 |
38 | ### Install script
39 |
40 | 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`
41 |
42 | ```sh
43 | curl -sL https://raw.githubusercontent.com/MrMarble/termsvg/master/scripts/install-termsvg.sh | sudo -E bash -
44 | # or with wget
45 | wget -O - https://raw.githubusercontent.com/MrMarble/termsvg/master/scripts/install-termsvg.sh | sudo -E bash -
46 | ```
47 |
48 | > [!NOTE]
49 | > Windows binary does not have the `rec` command.
50 |
51 | ---
52 |
53 | ## Usage
54 |
55 | termsvg is composed of multiple commands, similar to `git`, `docker` or
56 | `asciinema`.
57 |
58 | When you run `termsvg` with no arguments help message is displayed, listing
59 | all available commands with their options.
60 |
61 | ### `rec