cli-screencast

An easy to use Node.js API for rendering terminal screenshots and recordings to SVG or PNG

---

Read the docs at cli-screencast.io

Features

• Capture terminal recordings from spawned processes, shell sessions, or writes to process.stdout.
• Render screenshots and recordings to svg and png.

Installation

Install with npm:

npm install cli-screencast

Or with yarn:

yarn add cli-screencast

API

renderScreen

For rendering a single terminal frame as a screenshot.

captureShell

For launching and recording a terminal shell session.

captureSpawn

For running and recording a spawned child process.

captureCallback

For capturing node.js code within a callback function.

captureFrames

For rendering an animated terminal screen capture from an array of content frames.

renderData

For rendering capture data generated by one of the other api methods.

License

MIT