Record terminal sessions as SVG animations
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Add support for CircleCI Nov 4, 2018
docs Release 0.7.0 Dec 9, 2018
examples Release 0.7.0 Dec 9, 2018
man Release 0.7.0 Dec 9, 2018
scripts Replace pkg_resources by pkgutil Jul 22, 2018
termtosvg Release 0.7.0 Dec 9, 2018
.travis.yml Add support for CircleCI Nov 4, 2018
CHANGELOG.md Release 0.7.0 Dec 9, 2018
LICENSE Add licence May 9, 2018
MANIFEST.in Include all manuals in package (#87) Dec 11, 2018
Makefile Release 0.7.0 Dec 9, 2018
README.md Release 0.7.0 Dec 9, 2018
__main__.py Replace pkg_resources by pkgutil Jul 22, 2018
setup.py Release 0.7.0 Dec 9, 2018

README.md

Build Status CircleCI

termtosvg

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

Features

  • Produce lightweight and clean looking animations embeddable on a project page
  • Custom color themes, terminal UI and animation controls via SVG templates
  • Compatible with asciinema recording format

Installation

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

pip3 install --user termtosvg

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

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

$ firefox /tmp/termtosvg_exp5nsr4.svg

Dependencies

termtosvg uses:

  • pyte to render the terminal screen
  • lxml to work with SVG data