2015-03-06 11:59:27 +01:00
|
|
|
# asciinema
|
2013-10-03 17:57:40 +02:00
|
|
|
|
2021-10-02 16:44:28 +02:00
|
|
|
[](https://github.com/asciinema/asciinema/actions/workflows/asciinema.yml)
|
2017-09-16 11:08:32 +02:00
|
|
|
[](https://pypi.org/project/asciinema/)
|
2015-08-07 17:04:55 -04:00
|
|
|
[](https://raw.githubusercontent.com/asciinema/asciinema/master/LICENSE)
|
2013-10-03 17:57:40 +02:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
__asciinema__ (aka asciinema CLI or asciinema recorder) is a command-line tool
|
|
|
|
|
for recording terminal sessions.
|
2013-10-03 17:57:40 +02:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
Unlike typical _screen_ recording software, which records visual output of a
|
|
|
|
|
screen into a heavyweight video files (`.mp4`, `.mov`), asciinema recorder runs
|
|
|
|
|
_inside a terminal_, capturing terminal session output into a lightweight
|
|
|
|
|
recording files in the
|
|
|
|
|
[asciicast](https://docs.asciinema.org/manual/asciicast/v2/) format (`.cast`).
|
2015-03-28 17:56:20 +01:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
The recordings can be replayed in a terminal, embedded on a web page with the
|
|
|
|
|
[asciinema player](https://docs.asciinema.org/manual/player/), or published to
|
|
|
|
|
an [asciinema server](https://docs.asciinema.org/manual/server/), such as
|
|
|
|
|
[asciinema.org](https://asciinema.org), for further sharing.
|
2023-10-03 10:06:20 +02:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
[](https://asciinema.org/a/85R4jTtjKVRIYXTcKCNq0vzYH?autoplay=1)
|
2023-10-03 10:06:20 +02:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
Notable features:
|
2023-10-03 10:06:20 +02:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
* [recording](https://docs.asciinema.org/manual/cli/usage/#asciinema-rec-filename)
|
|
|
|
|
and
|
|
|
|
|
[replaying](https://docs.asciinema.org/manual/cli/usage/#asciinema-play-filename)
|
|
|
|
|
of sessions inside a terminal,
|
|
|
|
|
* [light-weight recording
|
|
|
|
|
format](https://docs.asciinema.org/manual/asciicast/v2/), which is highly
|
|
|
|
|
compressible (down to 15% of the original size e.g. with `zstd` or `gzip`),
|
|
|
|
|
* integration with [asciinema
|
|
|
|
|
server](https://docs.asciinema.org/manual/server/), e.g.
|
|
|
|
|
[asciinema.org](https://asciinema.org), for easy recording hosting.
|
2017-11-18 22:09:15 +01:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
Recording is as easy as running this command in your shell:
|
2015-06-23 20:20:22 +02:00
|
|
|
|
2021-10-30 12:45:23 -04:00
|
|
|
```sh
|
2023-12-20 16:29:59 +01:00
|
|
|
asciinema rec demo.cast
|
2017-11-19 18:29:50 +01:00
|
|
|
```
|
2015-03-09 17:05:14 +01:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
Check out the [Getting started
|
|
|
|
|
guide](https://docs.asciinema.org/getting-started/) for installation and usage
|
|
|
|
|
overview.
|
2015-05-24 12:29:58 +02:00
|
|
|
|
2023-12-20 16:45:02 +01:00
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
This branch (`main`) tracks the previous generation of the asciinema CLI,
|
|
|
|
|
written in Python. This codebase is now in maintenance mode, and no more
|
|
|
|
|
features will be added to it. All effort goes into the upcoming 3.0 (`develop`
|
|
|
|
|
branch), which is a complete [rewrite in
|
|
|
|
|
Rust](https://discourse.asciinema.org/t/rust-rewrite-of-the-asciinema-cli/777).
|
|
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
## Donations
|
2015-05-24 12:29:58 +02:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
Sustainability of asciinema development relies on donations and sponsorships.
|
2015-05-24 12:29:58 +02:00
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
Please help the software project you use and love. Become a
|
|
|
|
|
[supporter](https://docs.asciinema.org/donations/#individuals) or a [corporate
|
|
|
|
|
sponsor](https://docs.asciinema.org/donations/#corporate-sponsorship).
|
2023-09-19 10:07:32 +02:00
|
|
|
|
|
|
|
|
asciinema is sponsored by:
|
|
|
|
|
|
|
|
|
|
- [Brightbox](https://www.brightbox.com/)
|
|
|
|
|
|
2023-06-20 10:20:48 +02:00
|
|
|
## Consulting
|
|
|
|
|
|
2023-12-20 16:29:59 +01:00
|
|
|
If you're interested in integration or customization of asciinema to suit your
|
|
|
|
|
needs, check [asciinema consulting
|
|
|
|
|
services](https://docs.asciinema.org/consulting/).
|
2013-10-06 12:58:29 +02:00
|
|
|
|
2014-11-15 17:42:04 +01:00
|
|
|
## License
|
2013-10-06 12:58:29 +02:00
|
|
|
|
2023-02-21 17:49:22 +01:00
|
|
|
© 2011 Marcin Kulik.
|
2014-11-15 17:42:04 +01:00
|
|
|
|
2021-10-30 12:45:23 -04:00
|
|
|
All code is licensed under the GPL, v3 or later. See [LICENSE](./LICENSE) file
|
|
|
|
|
for details.
|
