Need help with termtosvg?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

nbedos
9.0K Stars 361 Forks BSD 3-Clause "New" or "Revised" License 190 Commits 12 Opened issues

Description

Record terminal sessions as SVG animations

Services available

!
?

Need anything else?

Contributors list

Note: As of June 2020 I do not have time to maintain termtosvg anymore and this repository is now read-only.

termtosvg

termtosvg is a Unix terminal recorder written in Python that renders your command line sessions as standalone SVG animations.

Example

Features

  • Produce lightweight and clean looking animations or still frames embeddable on a project page
  • Custom color themes, terminal UI and animation controls via user-defined SVG templates
  • Rendering of recordings in asciicast format made with asciinema

Installation

termtosvg is compatible with Linux, macOS and BSD OSes, requires Python >= 3.5 and can be installed as follows using pip: ```shell

Create virtualenv named '.venv'

python3 -m venv .venv

Activate virtualenv

source .venv/bin/activate pip3 install termtosvg ``

Then run termtosvg by calling either
termtosvg
or
python3 -m termtosvg`.

Various independently maintained, OS specific packages have been made available by the community:

| OS | Repository | Installation command | |----------|-------------|---| | Archlinux | Arch |

pacman -S termtosvg
| | FreeBSD | ports | | | Gentoo | media-gfx/termtosvg |
emerge media-gfx/termtosvg
| | macOS | Homebrew |
brew install termtosvg
| | OpenBSD | ports | | | NixOS | nixpkgs | |

Basic usage

Start recording with:

$ termtosvg
Recording started, enter "exit" command or Control-D to end

You are now in a subshell where you can type your commands as usual. Once you are done, exit the shell to end the recording:

$ exit
Recording ended, file is /tmp/termtosvg_exp5nsr4.svg

Then, use your favorite web browser to play the animation:

$ firefox /tmp/termtosvg_exp5nsr4.svg

Finally, embedding the animation in e.g. a README.md file on GitHub can be achieved with a relative link to the animation:

markdown
![Example](./docs/examples/awesome_window_frame.svg)

See the manual page for more details.

Dependencies

termtosvg uses: * pyte to render the terminal screen * lxml to work with SVG data

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.