Instalación y uso del CLI

El CLI de AgentGIF te permite subir, grabar, buscar y gestionar GIFs de terminal desde tu terminal. Disponible en 5 lenguajes — elige el que se adapte a tu stack.

Instalar

El CLI está publicado en todos los registros de paquetes principales. Cada implementación ofrece los mismos comandos principales.

Lenguaje	Comando de instalación	Registro
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

Verifica la instalación:

agentgif --version
agentgif --help

Autenticación

Antes de subir o gestionar GIFs, autentícate con tu cuenta de GitHub:

agentgif login

Esto abre tu navegador para GitHub OAuth. Después de la autorización, el CLI almacena tu clave de API localmente en ~/.config/agentgif/config.json.

Alternativamente, configura tu clave de API directamente:

agentgif login --api-key YOUR_API_KEY

Get your API key from Settings → API Key.

Comprueba tu estado de autenticación:

agentgif whoami
# → @yourname (authenticated)

Subir

Sube un GIF con metadatos:

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

Opciones de carga

Bandera	Descripción
`--title`	Título del GIF (obligatorio)
`--command`	El comando demostrado
`--tags`	Etiquetas separadas por comas
`--description`	Texto de descripción
`--cast`	Ruta al archivo cast de asciinema v2
`--shell`	Shell usado (bash, zsh, fish)
`--visibility`	`public` (predeterminado) o `unlisted`
`--open`	Abrir la página del GIF en tu navegador después de la carga

Subir con archivo cast

Incluir un archivo cast habilita la capa legible por máquina para agentes de IA:

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

Grabar con 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

Opciones de grabación

Bandera	Descripción
`--theme`	Terminal theme (see themes)
`--output`	Ruta del archivo de salida (predeterminado: mismo nombre que la cinta con .gif)
`--upload`	Subir inmediatamente después de grabar
`--title`	Título para carga automática
`--tags`	Etiquetas para carga automática

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

Búsqueda

Busca en todos los GIFs públicos:

agentgif search "docker compose"

La salida muestra el ID del GIF, título, comando y recuento de vistas en una tabla formateada.

Filtros de búsqueda

# 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

Gestionar GIFs

Listar tus GIFs

agentgif list
agentgif list --limit 50

Ver detalles del GIF

agentgif info xK9mQ2pL

Editar un GIF

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

Eliminar un GIF

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

Configuración

El CLI almacena la configuración en ~/.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 de entorno

Las variables de entorno anulan la configuración del archivo de configuración:

Variable	Descripción
`AGENTGIF_API_KEY`	Clave de API (anula la configuración)
`AGENTGIF_API_URL`	URL base de la API
`AGENTGIF_THEME`	Tema VHS predeterminado

Útil en pipelines de CI/CD:

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

← Volver a la documentación · Guía de incrustación →