Установка и использование CLI

AgentGIF CLI позволяет загружать, записывать, искать и управлять терминальными GIF прямо из терминала. Доступен на 5 языках — выберите подходящий для вашего стека.

Установка

CLI опубликован во всех основных реестрах пакетов. Каждая реализация предоставляет одни и те же основные команды.

Язык	Команда установки	Реестр
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

Проверьте установку:

agentgif --version
agentgif --help

Аутентификация

Перед загрузкой или управлением GIF выполните аутентификацию с помощью аккаунта GitHub:

agentgif login

Это откроет ваш браузер для GitHub OAuth. После авторизации CLI сохранит ваш API-ключ локально по пути ~/.config/agentgif/config.json.

Или задайте ваш API-ключ напрямую:

agentgif login --api-key YOUR_API_KEY

Get your API key from Settings → API Key.

Проверьте статус аутентификации:

agentgif whoami
# → @yourname (authenticated)

Загрузить

Загрузите GIF с метаданными:

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

Параметры загрузки

Флаг	Описание
`--title`	Заголовок GIF (обязательно)
`--command`	Демонстрируемая команда
`--tags`	Теги, разделённые запятыми
`--description`	Текст описания
`--cast`	Путь к cast-файлу asciinema v2
`--shell`	Используемая оболочка (bash, zsh, fish)
`--visibility`	`public` (по умолчанию) или `unlisted`
`--open`	Открыть страницу GIF в браузере после загрузки

Загрузка с Cast-файлом

Включение cast-файла активирует машиночитаемый уровень для ИИ-агентов:

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

Запись с 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

Параметры записи

Флаг	Описание
`--theme`	Terminal theme (see themes)
`--output`	Путь к выходному файлу (по умолчанию: то же имя, что и у tape, с расширением .gif)
`--upload`	Загрузить сразу после записи
`--title`	Заголовок для автозагрузки
`--tags`	Теги для автозагрузки

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

Поиск

Поиск по всем публичным GIF:

agentgif search "docker compose"

Вывод показывает ID GIF, заголовок, команду и количество просмотров в форматированной таблице.

Фильтры поиска

# 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

Управление GIF

Список ваших GIF

agentgif list
agentgif list --limit 50

Просмотр деталей GIF

agentgif info xK9mQ2pL

Редактировать GIF

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

Удалить GIF

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

Конфигурация

CLI хранит конфигурацию по пути ~/.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
}

Переменные среды

Переменные среды переопределяют настройки конфигурационного файла:

Переменная	Описание
`AGENTGIF_API_KEY`	API-ключ (переопределяет конфигурацию)
`AGENTGIF_API_URL`	Базовый URL API
`AGENTGIF_THEME`	Тема VHS по умолчанию

Полезно в CI/CD-конвейерах:

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

← Назад к документации · Руководство по встраиванию →