Asciinema, l'enregistreur de console

Asciinema permet de faire des enregistrements ou "asciicast" de l'écran afin de présenter un travail en ligne de commande. Il est particulièrement utile pour les démonstrations, les tutoriels, ou la documentation technique.

Installation

Via apt-get

apt-get update
apt-get install asciinema

Utilisation

Enregistrement d'un Asciicast
Pour enregistrer une session terminal, utilisez la commande suivante. L'enregistrement commence dès que la commande est lancée. Utilisez CTRL+D pour terminer :

asciinema rec test.cast

Lecture de l'Asciicast
Pour rejouer un enregistrement localement :

asciinema play test.cast

Options d'enregistrement

Changer la vitesse de lecture : Vous pouvez ajuster la vitesse de lecture lors de la conversion ou en ajoutant l'option --speed lors de l'enregistrement. Par exemple, pour doubler la vitesse de lecture :

asciinema rec --speed 2 test.cast

Fixer la durée d'inactivité : Par défaut, Asciinema enregistre les périodes d'inactivité dans la session. Vous pouvez limiter ces pauses avec l'option --idle-time-limit. Par exemple :

asciinema rec --idle-time-limit=2 test.cast

Intégration d'un Cast dans MkDocs

Si vous utilisez MkDocs pour la documentation, vous pouvez intégrer directement un enregistrement Asciinema en utilisant le plugin Asciinema pour MkDocs.

Installation du plugin MkDocs pour Asciinema
Ajoutez le plugin à votre configuration mkdocs.yml :

plugins:
    - mkdocs-asciinema

Installation du module asciinema

pip install mkdocs-asciinema

Ajouter l'enregistrement dans une page
Pour intégrer un enregistrement, utilisez simplement la balise suivante dans votre fichier Markdown :

![asciicast](../../asciinema/docker.cast)

Vous pouvez également héberger vos casts sur asciinema.org et utiliser l'URL fournie pour l'intégration dans MkDocs.

SVG-Term

svg-term-cli permet de convertir un enregistrement Asciinema au format SVG, facilitant ainsi son intégration dans des pages web ou de la documentation statique.

Installation

Via npm :

apt-get install npm
npm install -g svg-term-cli

Utilisation

Conversion d'un Asciicast en SVG
Pour convertir un fichier .cast en SVG, utilisez la commande suivante :

svg-term --in test.cast --out test.svg --window

L'option --window permet de générer un SVG avec une bordure de fenêtre autour du terminal, offrant une meilleure présentation visuelle.

Personnalisation
Vous pouvez personnaliser la sortie SVG avec différentes options comme la couleur de fond, le titre de la fenêtre ou encore la largeur/hauteur du terminal. Voici un exemple qui change la couleur de fond et ajoute un titre à la fenêtre :

svg-term --in test.cast --out test.svg --window --frame --padding-x 2 --padding-y 1 --title "Démo"

Exemple

Voici un exemple d'enregistrement converti en SVG :