Installation et utilisation du CLI

Le CLI AgentGIF vous permet de téléverser, enregistrer, rechercher et gérer des GIF terminaux depuis votre terminal. Disponible en 5 langages — choisissez celui qui correspond à votre stack.

Installation

Le CLI est publié sur tous les registres de paquets majeurs. Chaque implémentation fournit les mêmes commandes essentielles.

Langage	Commande d'installation	Registre
Python	`pip install agentgif`	PyPI
Node.js	`npm install -g @agentgif/cli`	npm
Go	`go install github.com/agentgif/cli@latest`	pkg.go.dev
Rust	`cargo install agentgif`	crates.io
Ruby	`gem install agentgif`	RubyGems

Vérifier l'installation :

agentgif --version
agentgif --help

Authentification

Avant de téléverser ou gérer des GIF, authentifiez-vous avec votre compte GitHub :

agentgif login

Cela ouvre votre navigateur pour GitHub OAuth. Après autorisation, le CLI stocke votre clé API localement dans ~/.config/agentgif/config.json.

Vous pouvez également définir votre clé API directement :

agentgif login --api-key YOUR_API_KEY

Get your API key from Settings → API Key.

Vérifier votre statut d'authentification :

agentgif whoami
# → @yourname (authenticated)

Téléverser

Téléverser un GIF avec des métadonnées :

agentgif upload demo.gif \
  --title "Docker Compose Up" \
  --command "docker compose up -d" \
  --tags docker,compose,containers \
  --description "Starting services with Docker Compose"

Options de téléversement

Option	Description
`--title`	Titre du GIF (obligatoire)
`--command`	La commande démontrée
`--tags`	Étiquettes séparées par des virgules
`--description`	Texte de description
`--cast`	Chemin vers le fichier cast Asciinema v2
`--shell`	Shell utilisé (bash, zsh, fish)
`--visibility`	`public` (par défaut) ou `unlisted`
`--open`	Ouvrir la page du GIF dans votre navigateur après le téléversement

Téléverser avec un fichier Cast

Inclure un fichier cast active la couche lisible par machine pour les agents IA :

agentgif upload demo.gif --cast demo.cast --title "Git Rebase" --tags git

Enregistrer avec VHS

The Python CLI can record terminal sessions directly using VHS (must be installed separately).

# Record from a VHS tape file
agentgif record demo.tape --theme dracula

# Record and immediately upload
agentgif record demo.tape --upload --title "My Demo" --tags demo

Options d'enregistrement

Option	Description
`--theme`	Terminal theme (see themes)
`--output`	Chemin du fichier de sortie (par défaut : même nom que le fichier tape avec .gif)
`--upload`	Téléverser immédiatement après l'enregistrement
`--title`	Titre pour le téléversement automatique
`--tags`	Étiquettes pour le téléversement automatique

VHS must be installed separately: brew install vhs (macOS) or see the recording guide.

Recherche

Rechercher dans tous les GIF publics :

agentgif search "docker compose"

La sortie affiche l'identifiant GIF, le titre, la commande et le nombre de vues dans un tableau formaté.

Filtres de recherche

# Filter by tag
agentgif search "build" --tag docker

# Filter by shell
agentgif search "alias" --shell zsh

# Sort by views instead of relevance
agentgif search "git" --sort views

Gérer les GIF

Lister vos GIF

agentgif list
agentgif list --limit 50

Voir les détails du GIF

agentgif info xK9mQ2pL

Modifier un GIF

agentgif edit xK9mQ2pL --title "New Title" --tags git,rebase

Supprimer un GIF

agentgif delete xK9mQ2pL
# → Are you sure? (y/N)

Configuration

Le CLI stocke la configuration dans ~/.config/agentgif/config.json :

{
  "api_key": "ag_xxxxxxxxxxxx",
  "api_url": "https://agentgif.com/api/v1",
  "default_theme": "catppuccin-mocha",
  "default_shell": "zsh",
  "auto_open": false
}

Variables d'environnement

Les variables d'environnement remplacent les paramètres du fichier de configuration :

Variable	Description
`AGENTGIF_API_KEY`	Clé API (remplace la configuration)
`AGENTGIF_API_URL`	URL de base de l'API
`AGENTGIF_THEME`	Thème VHS par défaut

Utile dans les pipelines CI/CD :

AGENTGIF_API_KEY=${{ secrets.AGENTGIF_KEY }} agentgif upload dist/demo.gif --title "CI Build"

← Retour à la documentation · Guide d'intégration →