Comment enregistrer et partager des sessions de terminal en utilisant Terminalizer sur Ubuntu 18.04

L’auteur a choisi Electronic Frontier Foundation pour recevoir un don dans le cadre du programme Write for DOnations.

Introduction

Terminalizer est une application d’enregistrement de terminal qui vous permet d’enregistrer votre session de terminal en temps réel, puis de la lire ultérieurement. Elle fonctionne de la même manière qu’un enregistreur d’écran de bureau, mais fonctionne dans votre terminal.

L’enregistrement de votre session de terminal est utile si vous voulez revoir une activité particulière, ou pour aider à déboguer une erreur particulièrement délicate. Les enregistrements réalisés avec Terminalizer peuvent également être exportés sous forme de GIF animés, ce qui est idéal pour le partage en ligne ou l’ajout de contenu marketing pour votre logiciel.

Dans ce tutoriel, vous allez installer Terminalizer, l’utiliser pour enregistrer et lire des sessions de terminal, personnaliser vos enregistrements, puis les exporter pour les partager en ligne.

Conditions préalables

Pour suivre ce tutoriel, vous aurez besoin de :

• Un serveur Ubuntu 18.04 configuré en suivant la Configuration initiale du serveur avec Ubuntu 18.04, y compris un utilisateur sudo non root.

• Node.js et npm, qui peuvent être installés en suivant la section Installation de la version stable pour Ubuntu dans Comment installer Node.js sur Ubuntu 18.04.

Si vous souhaitez partager vos enregistrements en ligne, vous aurez également besoin de :

• Un compte gratuit sur le site Web de Terminalizer.

Une fois que tout cela est prêt, connectez-vous à votre serveur en tant qu’utilisateur non root pour commencer.

Étape 1 - Installation de Terminalizer

Dans cette étape, vous allez télécharger et installer Terminalizer sur votre système. Terminalizer est écrit en utilisant Node.js, et peut être installé en utilisant le gestionnaire de paquets npm.

Pour installer Terminalizer sur votre système, exécutez la commande suivante :

sudo npm install --global --allow-root --unsafe-perm=true terminalizer

Terminalizer utilise le framework d’application Electron pour exporter des sessions de terminal enregistrées en format GIF. L’argument de commande --unsafe-perms=true est nécessaire afin d’installer Electron sur votre système d’une manière globale.

Une fois Terminalizer installé, vous verrez une sortie semblable à ce qui suit :

Output
. . .
/usr/local/lib
└── terminalizer@0.7.1

Ensuite, vérifiez l’installation de Terminalizer en exécutant :

terminalizer --version

Une sortie semblable à celle-ci s’affichera :

Output
0.7.1

Enfin, générez un fichier de configuration Terminalizer par défaut, que vous pouvez utiliser pour la personnalisation avancée de Terminalizer (plus détaillée à l’étape 4) :

terminalizer init

Cela donnera un résultat similaire à ce qui suit :

Output
The global config directory is created at
/home/user/.terminalizer

Maintenant que vous avez installé Terminalizer, vous pouvez effectuer votre premier enregistrement de terminal.

Étape 2 - Enregistrement et Lecture d’une session de terminal

Dans cette étape, vous allez enregistrer et lire une session de terminal.

Pour commencer, configurez un nouvel enregistrement Terminalizer en utilisant le nom de votre choix :

terminalizer record your-recording

Cela donnera la sortie suivante pour indiquer que l’enregistrement a démarré :

Output
The recording session has started
Press Ctrl+D to exit and save the recording

Vous pouvez maintenant continuer à faire tout ce que vous voulez dans votre terminal. Chaque pression de touche et commande sera enregistrée en temps réel par Terminalizer.

Par exemple :

pwd
date
whoami
echo "Hello, world!"

Lorsque vous souhaitez arrêter l’enregistrement, appuyez sur CTRL+D. Terminalizer sauvegardera ensuite l’enregistrement dans le fichier spécifié au format YAML, par exemple, your-recording.yml.

Output
Successfully Recorded
The recording data is saved into the file:
/home/user/your-recording.yml

Vous pouvez être invité par Terminalizer à partager votre enregistrement en ligne. Appuyez simplement sur CTRL+C pour annuler ce partage pour l’instant, car vous pouvez lire l’enregistrement de terminal localement pour commencer.

Ensuite, lisez la session de terminal enregistrée avec la commande suivante :

terminalizer play your-recording

Cela rejouera la session enregistrée en temps réel dans votre terminal :

Output
user@droplet:~$ pwd
/home/user
user@droplet:~$ date
Sun Mar  8 14:55:36 UTC 2020
user@droplet:~$ whoami
user
user@droplet:~$ echo "Hello, world!"
Hello, world!
user@droplet:~$ logout

Vous pouvez également ajuster la vitesse de lecture de votre enregistrement en utilisant l’option --speed-factor.

Par exemple, ce qui suit jouera votre enregistrement deux fois plus lentement (50 % de la vitesse) :

terminalizer play your-recording --speed-factor 2

Vous pouvez aussi lire votre enregistrement deux fois plus vite (200 % de la vitesse) :

terminalizer play your-recording --speed-factor 0.5

Vous avez enregistré et lu votre session de terminal. Maintenant, vous pouvez partager en ligne une session de terminal enregistrée.

Étape 3 - Partage d’une session de terminal enregistrée

Dans cette étape, vous allez partager votre session de terminal enregistrée sur la page Terminalizer Explore.

Commencez par sélectionner la session enregistrée que vous souhaitez partager :

terminalizer share your-recording

Vous serez ensuite invité à fournir quelques métadonnées basiques sur votre enregistrement, telles que son titre et sa description :

Output
Please enter some details about your recording
? Title Title of Your Recording
? Description Description of Your Recording
? Tags such as git,bash,game Comma-separated Tags for Your Recording

Si c’est la première fois que vous partagez une session enregistrée à l’aide de Terminalizer, vous devrez lier votre compte Terminalizer. Terminalizer affichera un lien de vérification si nécessaire :

Output
Open the following link in your browser and login into your account
https://terminalizer.com/token?token=your-token

When you do it, press any key to continue

Une fois que vous avez visité le lien dans votre navigateur Web et que vous vous êtes connecté à votre compte Terminalizer, appuyez sur n’importe quelle touche pour continuer.

Terminalizer va maintenant télécharger votre enregistrement et vous fournir le lien pour le visualiser :

Output
Successfully Uploaded
The recording is available on the link:
https://terminalizer.com/view/your-recording-id

Visiter le lien dans un navigateur Web de bureau vous permettra de visualiser votre enregistrement partagé :

Vous avez partagé une session de terminal enregistrée sur le site Web de Terminalizer et l’avez consultée dans votre navigateur Web.

Étape 4 - Définition de la configuration avancée de Terminalizer

Maintenant que vous connaissez un peu Terminalizer, vous pouvez commencer à utiliser certaines des options de personnalisation les plus avancées, telles que la possibilité d’ajuster les couleurs et le style de l’affichage.

Chaque enregistrement hérite de la configuration par défaut du fichier de configuration global de Terminalizer, qui est situé dans ~/.terminalizer/config.yml. Cela signifie que vous pouvez modifier la configuration pour les enregistrements individuels directement en modifiant le fichier d’enregistrement (par exemple  : your-recording.yml). Vous pouvez également modifier la configuration globale, ce qui aura un impact sur tous les nouveaux enregistrements.

Dans cet exemple, vous allez modifier le fichier de configuration globale, mais ces instructions s’appliquent également aux fichiers de configuration d’enregistrements individuels.

Commencez par ouvrir le fichier de configuration globale de Terminalizer dans votre éditeur de texte, par exemple nano :

nano ~/.terminalizer/config.yml

Chacune des options de configuration disponibles dans le fichier est commentée afin d’expliquer ce qu’elle fait.

Il existe plusieurs options de configuration courantes que vous souhaiterez peut-être adapter à votre convenance :

• cols : fixe explicitement le nombre de colonnes de terminal utilisées pour votre enregistrement.
• rows : fixe explicitement le nombre de lignes de terminal utilisées pour votre enregistrement.
• frameDelay : ignore le délai entre chaque frappe pendant la lecture.
• maxIdleTime : spécifie un temps maximum entre les frappes pendant la lecture.
• cursorStyle : précise le style de curseur de terminal par défaut entre block, bar et underline.
• fontFamily : spécifie une liste de polices de lecture préférées, dans l’ordre de préférence.
• theme : ajuste le schéma de couleurs de la lecture, par exemple pour créer un terminal noir sur blanc, etc.

Par exemple, vous pouvez réaliser un affichage de terminal blanc sur noir en configurant les options suivantes :

. . .
theme:
  background: "white"
  foreground: "black"
. . .

Cela donnera un résultat similaire à ce qui suit :

Vous pouvez ajuster le style du curseur pour rendre l’enregistrement plus facile à comprendre, par exemple en remplaçant le curseur de style block par défaut par un curseur souligné de type underline :

. . .
cursorStyle: underline
. . .

Cela donnera un résultat semblable à ce qui suit :

Une fois que vous avez apporté les modifications souhaitées, enregistrez le fichier et retournez dans votre terminal.

Si vous avez modifié la configuration globale de Terminalizer, ces paramètres s’appliqueront à tous les nouveaux enregistrements à venir. Si vous modifiez une configuration d’enregistrement spécifique, Terminalizer appliquera immédiatement les changements à cet enregistrement en particulier.

Notez que le style de lecture personnalisé ne s’applique qu’aux sessions d’enregistrement partagées. Si vous lisez un enregistrement directement dans votre terminal, vous utiliserez toujours le style et la palette de couleurs de votre terminal par défaut.

Dans cette dernière étape, vous avez passé en revue certaines des options de configuration avancées pour Terminalizer.

Conclusion

Dans cet article, vous avez utilisé Terminalizer pour enregistrer et partager une session de terminal. Vous avez maintenant les connaissances nécessaires pour créer des démonstrations enregistrées de votre logiciel à utiliser dans du contenu marketing ou pour partager des astuces en ligne de commande avec des amis.

Si vous souhaitez rendre et exporter des enregistrements Terminalizer au format GIF, vous pouvez installer Terminalizer sur une machine avec une interface utilisateur ou un bureau graphique et utiliser les fonctions de rendu intégrées :

• Créez des GIF en utilisant Terminalizer

Vous pouvez également naviguer sur le site Web de Terminalizer pour voir les sessions de terminal enregistrées et partagées par d’autres utilisateurs :

• Explorez les enregistrements Terminalizer