Asciinema

De Wiki doc


Asciinema est un outil d'enregistrement du shell. Il permet de prendre une capture animée de chaque caractère évoluant dans une session utilisateur. L’intérêt principal de cette solution par rapport à une capture vidéo est la taille finale du fichier (c'est un bête fichier texte) et surtout, vu qu'il s'agit d'un fichier texte, il est vectoriel et sont contenu peut être sélectionné pour faire des copier/coller (une vidéo vectoriel ça claque non ?). Parfait pour faire de la documentation et cerise sur le gâteau, le lecteur est auto-hébergeable sur un serveur WEB (c'est un fichier Javascript) !

Installation

apt install asciinema

Enregistrement

asciinema rec toto.cast

INFORMATION

Pour terminer l'enregistrement, faites <ctrl>+<d> ou exit.

Lecture

asciinema play toto.cast

ASTUCE

Il est possible d'accélérer la vitesse de lecture par deux en ajoutant le paramètre -s 2.

Auto hébergement du lecteur

Installation du serveur web

apt install apache2

Téléchargement du lecteur

mkdir /var/www/asciinema
wget https://github.com/asciinema/asciinema-player/releases/download/v2.6.1/asciinema-player.css https://github.com/asciinema/asciinema-player/releases/download/v2.6.1/asciinema-player.js -P /var/www/asciinema

Mise en ligne

Copie du fichier d'enregistrement

cp toto.cast /var/www/asciinema/

Note: n'oubliez pas d'adapter votre hôte virtuel pour pointer sur ce répertoire.

Création de la page web

vim /var/www/asciinema
<html>
<head>
  ...
  <link rel="stylesheet" type="text/css" href="/asciinema-player.css" />
  ...
</head>
<body>
  ...
  <asciinema-player src="/demo.cast"></asciinema-player>
  ...
  <script src="/asciinema-player.js"></script>
</body>
</html>

Sources