Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nbedos/termtosvg
Record terminal sessions as SVG animations
https://github.com/nbedos/termtosvg
animation cli recorder recording shell svg svg-animations terminal
Last synced: 2 months ago
JSON representation
Record terminal sessions as SVG animations
- Host: GitHub
- URL: https://github.com/nbedos/termtosvg
- Owner: nbedos
- License: bsd-3-clause
- Archived: true
- Created: 2018-06-09T13:52:09.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-06-16T11:01:41.000Z (over 4 years ago)
- Last Synced: 2024-04-14T16:12:48.504Z (8 months ago)
- Topics: animation, cli, recorder, recording, shell, svg, svg-animations, terminal
- Language: Python
- Homepage: https://nbedos.github.io/termtosvg/
- Size: 1.34 MB
- Stars: 9,689
- Watchers: 132
- Forks: 437
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github - 录制终端成svg
- awesome-github-repos - nbedos/termtosvg - Record terminal sessions as SVG animations (Python)
- awesome - termtosvg
- awesome-repositories - nbedos/termtosvg - Record terminal sessions as SVG animations (Python)
- awesome-list - termtosvg
- awesome-hacking-lists - nbedos/termtosvg - Record terminal sessions as SVG animations (Python)
README
**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.
* [Gallery of examples](https://nbedos.github.io/termtosvg/pages/examples.html)
* [Gallery of templates](https://nbedos.github.io/termtosvg/pages/templates.html)
## 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](man/termtosvg-templates.md)
* 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](https://www.archlinux.org/packages/community/any/termtosvg/) |`pacman -S termtosvg` |
| FreeBSD | [ports](https://www.freshports.org/graphics/py-termtosvg) | |
| Gentoo | [media-gfx/termtosvg](https://packages.gentoo.org/packages/media-gfx/termtosvg) | `emerge media-gfx/termtosvg`|
| macOS | [Homebrew](https://formulae.brew.sh/formula/termtosvg) |`brew install termtosvg` |
| OpenBSD | [ports](https://github.com/openbsd/ports/tree/master/graphics/termtosvg) | |
| NixOS | [nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/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
```
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](README.md) file on GitHub can
be achieved with a relative link to the animation:
```markdown
```
See the [manual page](man/termtosvg.md) for more details.
## Dependencies
termtosvg uses:
* [pyte](https://github.com/selectel/pyte) to render the terminal screen
* [lxml](https://github.com/lxml/lxml) to work with SVG data