Skip to content

TermCap

TermCap 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

Install

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

pip3 install --user termcap

Usage

Simply start recording a terminal session with:

$ termcap record
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
✓ 录制完成，时长: 10.5秒，共 42 个事件
Recording ended, cast file is /tmp/termcap_exp5nsr4.cast

Finally, render the recording to an SVG animation:

$ termcap render /tmp/termcap_exp5nsr4.cast animation.svg
Rendering started
✓ 渲染完成
Rendering ended, SVG animation is animation.svg

You can then use your favorite web browser to play the animation:

$ firefox animation.svg