Instalação e Uso do CLI

O CLI do AgentGIF permite enviar, gravar, pesquisar e gerenciar GIFs de terminal a partir do seu terminal. Disponível em 5 linguagens — escolha a que melhor se encaixa no seu stack.

Instalação

O CLI é publicado em todos os principais registros de pacotes. Cada implementação fornece os mesmos comandos principais.

Linguagem	Comando de Instalação	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

Verifique a instalação:

agentgif --version
agentgif --help

Autenticação

Antes de enviar ou gerenciar GIFs, autentique-se com sua conta GitHub:

agentgif login

Isso abre seu navegador para o OAuth do GitHub. Após a autorização, o CLI armazena sua chave de API localmente em ~/.config/agentgif/config.json.

Alternativamente, defina sua chave de API diretamente:

agentgif login --api-key YOUR_API_KEY

Get your API key from Settings → API Key.

Verifique seu status de autenticação:

agentgif whoami
# → @yourname (authenticated)

Enviar

Envie um GIF com metadados:

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

Opções de Upload

Flag	Descrição
`--title`	Título do GIF (obrigatório)
`--command`	O comando demonstrado
`--tags`	Tags separadas por vírgula
`--description`	Texto de descrição
`--cast`	Caminho para o arquivo cast asciinema v2
`--shell`	Shell usado (bash, zsh, fish)
`--visibility`	`public` (padrão) ou `unlisted`
`--open`	Abrir a página do GIF no navegador após o upload

Enviar com Arquivo Cast

Incluir um arquivo cast habilita a camada legível por máquina para agentes de IA:

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

Gravar com 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

Opções de Gravação

Flag	Descrição
`--theme`	Terminal theme (see themes)
`--output`	Caminho do arquivo de saída (padrão: mesmo nome do tape com .gif)
`--upload`	Enviar imediatamente após gravar
`--title`	Título para envio automático
`--tags`	Tags para envio automático

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

Pesquisa

Pesquisar em todos os GIFs públicos:

agentgif search "docker compose"

A saída mostra ID do GIF, título, comando e contagem de visualizações em uma tabela formatada.

Filtros de Pesquisa

# 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

Gerenciar GIFs

Listar Seus GIFs

agentgif list
agentgif list --limit 50

Ver Detalhes do GIF

agentgif info xK9mQ2pL

Editar um GIF

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

Excluir um GIF

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

Configuração

O CLI armazena configuração em ~/.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
}

Variáveis de Ambiente

Variáveis de ambiente substituem as configurações do arquivo de configuração:

Variável	Descrição
`AGENTGIF_API_KEY`	Chave de API (substitui configuração)
`AGENTGIF_API_URL`	URL base da API
`AGENTGIF_THEME`	Tema VHS padrão

Útil em pipelines de CI/CD:

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

← Voltar à Documentação · Guia de Embed →