https://github.com/nodef/extra-asciinema
asciinema is a terminal screen recorder.
https://github.com/nodef/extra-asciinema
asciinema cat cat-sync extra rec rec-sync retime retime-data retime-sync upload upload-sync
Last synced: 3 months ago
JSON representation
asciinema is a terminal screen recorder.
- Host: GitHub
- URL: https://github.com/nodef/extra-asciinema
- Owner: nodef
- License: mit
- Created: 2020-04-04T00:38:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-08T17:16:01.000Z (6 months ago)
- Last Synced: 2025-07-03T06:06:37.193Z (3 months ago)
- Topics: asciinema, cat, cat-sync, extra, rec, rec-sync, retime, retime-data, retime-sync, upload, upload-sync
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/extra-asciinema
- Size: 150 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[asciinema] is a terminal screen recorder.
📦 [Node.js](https://www.npmjs.com/package/extra-asciinema),
🌐 [Web](https://www.npmjs.com/package/extra-asciinema.web),
📜 [Files](https://unpkg.com/extra-asciinema/),
📰 [Docs](https://nodef.github.io/extra-asciinema/).
📘 [Wiki](https://github.com/nodef/extra-asciinema/wiki/).
With this package you can **auto-generate** terminal recordings
for Node.js examples through **asciinema** *programmatically*.
But you need to [install asciinema first]!
This package is available in *Node.js* and *Web* formats (for `retimeData()`).
The web format is exposed as `extra_asciinema` standalone variable and can be
loaded from [jsDelivr CDN].
> Stability: [Experimental](https://www.youtube.com/watch?v=L1j93RnIxEo).
[jsDelivr CDN]: https://cdn.jsdelivr.net/npm/extra-asciinema.web/index.js
```javascript
const asciinema = require('extra-asciinema');
// import * as asciinema from 'extra-asciinema';
asciinema.recSync('saved.cast', {input: 'example.js'});
// runs example.js interactively in node.js, saves 'saved.cast'
asciinema.retimeSync('saved.cast', {inputDelay: 2});
// 'saved.cast' is updated
asciinema.uploadSync('saved.cast');
// asciicast URL
```
## Index
| Property | Description |
| ---- | ---- |
| [rec] | Record terminal session. |
| [recSync] | Record terminal session. |
| [cat] | Print full output of recorded asciicast to a terminal. |
| [catSync] | Print full output of recorded asciicast to a terminal. |
| [retime] | Update time in asciicast file. |
| [retimeData] | Update time in asciicast data. |
| [retimeSync] | Update time in asciicast file. |
| [upload] | Upload recorded asciicast to asciinema.org site. |
| [uploadSync] | Upload recorded asciicast to asciinema.org site. |
## References
- [asciinema - Record and share your terminal sessions, the simple way](https://asciinema.org)
[](https://www.youtube.com/watch?v=rjDX5ItsOnQ)
[](https://nodef.github.io)
[asciinema]: https://asciinema.org
[install asciinema first]: https://asciinema.org/docs/installation
[rec]: https://nodef.github.io/extra-asciinema/modules.html#rec
[recSync]: https://nodef.github.io/extra-asciinema/modules.html#recSync
[cat]: https://nodef.github.io/extra-asciinema/modules.html#cat
[catSync]: https://nodef.github.io/extra-asciinema/modules.html#catSync
[retime]: https://nodef.github.io/extra-asciinema/modules.html#retime
[retimeData]: https://nodef.github.io/extra-asciinema/modules.html#retimeData
[retimeSync]: https://nodef.github.io/extra-asciinema/modules.html#retimeSync
[upload]: https://nodef.github.io/extra-asciinema/modules.html#upload
[uploadSync]: https://nodef.github.io/extra-asciinema/modules.html#uploadSync