How to Record a Terminal GIF

1. Prérequis

Pour enregistrer des GIF terminaux, vous avez besoin de :

• VHS — a terminal recorder by Charm that converts scripted terminal sessions into GIFs
• ttyd — un serveur web terminal (dépendance VHS, installé automatiquement sur macOS)
• ffmpeg — pour l'encodage vidéo (installé automatiquement sur macOS)

VHS fonctionne en lisant un fichier .tape qui décrit les frappes clavier, les commandes et le timing — puis il rejoue ces actions dans un terminal virtuel et capture la sortie sous forme de GIF.

2. Installer VHS

Vérifier l'installation :

vhs --version

3. Créer un fichier tape

Un fichier tape est un script en texte brut qui indique à VHS quoi taper, quand attendre et quels paramètres utiliser. Créez un fichier appelé demo.tape :

Output demo.gif
Set Shell "bash"
Set FontSize 16
Set Width 1000
Set Height 580
Set Theme "Catppuccin Mocha"

Type "echo 'Hello, world!'"
Enter
Sleep 2s

Type "ls -la"
Enter
Sleep 3s

Commandes principales

4. Configurer les paramètres

Placez les commandes Set en haut de votre fichier tape, avant toute commande Type.

Paramètres recommandés pour AgentGIF

Set Shell "zsh"
Set FontSize 15
Set Width 1000
Set Height 580
Set Padding 20
Set Theme "Catppuccin Mocha"
Set TypingSpeed 50ms
Set CursorBlink false

Tous les paramètres disponibles

Thèmes

VHS est livré avec 44 thèmes intégrés. Choix populaires pour la documentation développeur :

Parcourez tous les thèmes avec aperçus en direct : Galerie de thèmes.

5. Enregistrer le GIF

vhs demo.tape

VHS ouvre un navigateur sans interface, rejoue le fichier tape et sauvegarde le GIF. Un enregistrement typique prend 10 à 30 secondes.

Prévisualiser avant de téléverser :

# macOS
open demo.gif

# Linux
xdg-open demo.gif

6. Optimiser la taille du fichier

AgentGIF accepte des GIF jusqu'à 10 Mo, mais les fichiers plus petits se chargent plus vite. Conseils pour réduire la taille des GIF :

Pour le meilleur équilibre qualité/taille, les paramètres recommandés ci-dessus produisent des GIF d'environ 100 à 300 Ko pour un enregistrement de 10 secondes.

7. Téléverser sur AgentGIF

Téléverser via CLI (le plus rapide) :

agentgif upload demo.gif \
  --title "Git Interactive Rebase" \
  --command "git rebase -i HEAD~3" \
  --tags git,rebase \
  --open

Or upload via the web interface — drag and drop the GIF file.

Inclure un fichier cast active la couche agent IA :

agentgif upload demo.gif --cast demo.cast --title "My Demo"

8. Fonctionnalités avancées des fichiers tape

Masquer/Afficher pour la configuration

Utilisez Hide/Show pour exécuter des commandes de configuration sans les enregistrer :

Hide
Type "cd /tmp/demo-project"
Enter
Type "mkdir -p src"
Enter
Show

# Now recording starts
Type "ls -la"
Enter
Sleep 2s

Formats de sortie multiples

VHS peut produire plusieurs formats simultanément :

Output demo.gif
Output demo.mp4
Output demo.webm

Variables d'environnement

Set Shell "bash"
Type "export PS1='$ '"
Enter
Hide
Sleep 500ms
Show

Raccourcis clavier

Ctrl+C     # Cancel current command
Ctrl+L     # Clear screen
Ctrl+D     # EOF / exit
Tab        # Tab completion
Up         # Previous command
Escape     # Escape key

9. Outils d'enregistrement alternatifs

Nous recommandons VHS pour les démos scriptées (reproductibles, versionnables) et asciinema + conversion VHS pour les enregistrements en direct.

See also: asciinema vs AgentGIF comparison.