Animaterm

📟 Automatically create terminal animations from script

Usage

Install from the github repo

npm i -g 'github:iamogbz/animaterm'

You do not need the peer dependencies except you need to render in the gif format

The terminalizer (tlz) renderer produces better gifs but requires an additional dependency

TODO: support rendering fancy console text colors and formatting

Run the animaterm bin with cli options

animaterm script.json output.svg

Also supports .gif as the output format

Set the renderer using the output extension e.g. output.gif or output.tlz

demo

This demo animation was created using only animaterm

Script

Samples available in the end-to-end scripts.

This is a JSON file with the following structure:

Step[]

That is a JSON array at the root where each Step is defined by the following interface:

https://github.com/iamogbz/animaterm/blob/d277aae/src/types.d.ts#L49-L83

Descriptions

clear

Flush terminal output

copy

Copy from start line and position to end line and position as defined in payload

enter

Return and run commands typed in previous steps

paste

Paste last copied text

NOTE: does not paste from system clipboard

type

Simulate user typing characters from text in payload

waitForOutput

Wait for data in payload to be displayed in the terminal

Config

Defined by the interface Config:

https://github.com/iamogbz/animaterm/blob/d277aae/src/types.d.ts#L1-L35

TODO: add instructions on overriding the default config