# Asciinema

Terminal session recorder.

## Table of contents <!-- omit in toc -->

1. [TL;DR](#tldr)
1. [Further readings](#further-readings)

## TL;DR

```sh
# Installation.
sudo apt-get install asciinema
brew install 'asciinema'
sudo dnf install 'asciinema'
sudo pacman -S 'asciinema'
python3 -m 'pip' install --user 'asciinema'

# Record sessions locally.
asciinema rec 'path/to/file.cast'
asciinema rec -i 2 'path/to/file.cast' -t 'title' --overwrite -c 'command'

# Record sessions *and* upload them to the website.
asciinema rec

# Play local sessions.
asciinema play 'path/to/file.cast'

# Share local recordings on the website.
asciinema upload 'path/to/file.cast'
```

## Further readings

- [Website]
- [Github]
- [`agg`][agg] to convert cast files into GIFs

<!--
  References
  -->

<!-- Upstream -->
[github]: https://github.com/asciinema/asciinema
[website]: https://asciinema.org/

<!-- Knowledge base -->
[agg]: agg.md
