acecode / svg-term-cli

Share terminal sessions via SVG and CSS

Share terminal sessions as razor-sharp animated SVG everywhere

Example generated with svg-term --cast 113643 --out examples/parrot.svg --frame --no-cursor --from=4500

svg-term-cli

• 💄 Render asciicast to animated SVG
• 🌐 Share asciicasts everywhere (sans JS)
• 🤖 Style with common color profiles

Install

npm install -g svg-term-cli

Usage

Generate the parrot.svg example from asciicast

svg-term --cast=113643 --out examples/parrot.svg --frame

Interface

$ svg-term --help

Usage
    $ svg-term [options]

  Options
    --at            timestamp of frame to render in ms [number]
    --cast          asciinema cast id to download [string], required if no stdin provided
    --frame         wether to frame the result with an application window [boolean]
    --from          lower range of timeline to render in ms [number]
    --height        height in lines [number]
    --help          print this help [boolean]
    --no-cursor     disable cursor rendering [boolean]
    --no-optimize   disable svgo optimization [boolean]
    --out           output file, emits to stdout if omitted
    --padding       distance between text and image bounds
    --padding-x     distance between text and image bounds on x axis
    --padding-y     distance between text and image bounds on y axis
    --profile       terminal profile file to use [file], requires --term
    --term          terminal profile format, requires [iterm2, xrdb, xresources, terminator, konsole, terminal, remmina, termite, tilda, xcfe] --profile
    --to            upper range of timeline to render in ms [number]
    --width         width in columns [number]

  Examples
    $ echo rec.json | svg-term
    $ svg-term --cast 113643
    $ svg-term --cast 3 --from 4000 --to 6000 --out nyan.svg
    $ svg-term --cast rfS1M5ynKm1hGaBqJYJj0mGCi --at 40000 --out jsvu.svg

Rationale

Replace GIF asciicast recordings where you can not use the asciinema player, e.g. README.md files on GitHub and the npm registry.

The image at the top of this README is an example. See how sharp the text looks, even when you zoom in? That’s because it’s an SVG!

Related

• asciinema/asciinema - Terminal session recorder
• derhuerst/asciicast-to-svg - Render frames of Asciicasts as SVGs
• marionebl/svg-term - Render asciicast to animated SVG
• marionebl/term-schemes - Parse and normalize common terminal emulator color schemes

Gallery

• marionebl/commitlint
• marionebl/share-cli
• marionebl/remote-share-cli

License

Copyright 2017. Released under the MIT license.