CLI-Installation & Verwendung

Die AgentGIF CLI ermöglicht das Hochladen, Aufnehmen, Suchen und Verwalten von Terminal-GIFs aus Ihrem Terminal. In 5 Sprachen verfügbar — wählen Sie die, die zu Ihrem Stack passt.

Installieren

Die CLI ist in allen wichtigen Paket-Registries veröffentlicht. Jede Implementierung bietet dieselben Kernbefehle.

Sprache	Installationsbefehl	Registry
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

Installation überprüfen:

agentgif --version
agentgif --help

Authentifizierung

Vor dem Hochladen oder Verwalten von GIFs mit Ihrem GitHub-Konto authentifizieren:

agentgif login

Dies öffnet Ihren Browser für GitHub OAuth. Nach der Autorisierung speichert die CLI Ihren API-Schlüssel lokal unter ~/.config/agentgif/config.json.

Alternativ können Sie Ihren API-Schlüssel direkt festlegen:

agentgif login --api-key YOUR_API_KEY

Get your API key from Settings → API Key.

Authentifizierungsstatus prüfen:

agentgif whoami
# → @yourname (authenticated)

Hochladen

Ein GIF mit Metadaten hochladen:

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

Upload-Optionen

Flag	Beschreibung
`--title`	GIF-Titel (erforderlich)
`--command`	Der vorgeführte Befehl
`--tags`	Kommagetrennte Tags
`--description`	Beschreibungstext
`--cast`	Pfad zur asciinema v2-Cast-Datei
`--shell`	Verwendete Shell (bash, zsh, fish)
`--visibility`	`public` (Standard) oder `unlisted`
`--open`	Die GIF-Seite nach dem Upload im Browser öffnen

Mit Cast-Datei hochladen

Das Hinzufügen einer Cast-Datei aktiviert die maschinenlesbare Schicht für KI-Agenten:

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

Mit VHS aufnehmen

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

Aufnahme-Optionen

Flag	Beschreibung
`--theme`	Terminal theme (see themes)
`--output`	Ausgabedateipfad (Standard: gleicher Name wie Tape mit .gif)
`--upload`	Sofort nach der Aufnahme hochladen
`--title`	Titel für automatischen Upload
`--tags`	Tags für automatischen Upload

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

Suche

Über alle öffentlichen GIFs suchen:

agentgif search "docker compose"

Die Ausgabe zeigt GIF-ID, Titel, Befehl und Aufrufzahl in einer formatierten Tabelle.

Suchfilter

# 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

GIFs verwalten

Eigene GIFs auflisten

agentgif list
agentgif list --limit 50

GIF-Details anzeigen

agentgif info xK9mQ2pL

Ein GIF bearbeiten

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

Ein GIF löschen

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

Konfiguration

Die CLI speichert die Konfiguration unter ~/.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
}

Umgebungsvariablen

Umgebungsvariablen überschreiben die Konfigurationsdateieinstellungen:

Variable	Beschreibung
`AGENTGIF_API_KEY`	API-Schlüssel (überschreibt Konfiguration)
`AGENTGIF_API_URL`	API-Basis-URL
`AGENTGIF_THEME`	Standard-VHS-Theme

Nützlich in CI/CD-Pipelines:

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

← Zurück zur Dokumentation · Einbettungsleitfaden →