Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luciancooper/cli-screencast
Render captured terminal sessions to animated svg
https://github.com/luciancooper/cli-screencast
Last synced: 2 days ago
JSON representation
Render captured terminal sessions to animated svg
- Host: GitHub
- URL: https://github.com/luciancooper/cli-screencast
- Owner: luciancooper
- License: mit
- Created: 2021-09-06T19:04:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-26T02:11:21.000Z (2 months ago)
- Last Synced: 2024-11-26T03:19:51.758Z (2 months ago)
- Language: TypeScript
- Size: 3.18 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
An easy to use Node.js API for rendering terminal screenshots and recordings to SVG or PNG
---
**Read the docs at [cli-screencast.io](https://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`:
```bash
npm install cli-screencast
```
Or with `yarn`:
```bash
yarn add cli-screencast
```
## API
#### [`renderScreen`](https://cli-screencast.io/renderScreen)
For rendering a single terminal frame as a screenshot.
#### [`captureShell`](https://cli-screencast.io/captureShell)
For launching and recording a terminal shell session.
#### [`captureSpawn`](https://cli-screencast.io/captureSpawn)
For running and recording a spawned child process.
#### [`captureCallback`](https://cli-screencast.io/captureCallback)
For capturing node.js code within a callback function.
#### [`captureFrames`](https://cli-screencast.io/captureFrames)
For rendering an animated terminal screen capture from an array of content frames.
#### [`renderData`](https://cli-screencast.io/renderData)
For rendering capture data generated by one of the other api methods.
## License
[MIT](LICENSE)