Cài đặt & Cách dùng CLI

AgentGIF CLI cho phép bạn tải lên, ghi hình, tìm kiếm và quản lý GIF terminal từ terminal của bạn. Có sẵn bằng 5 ngôn ngữ — chọn ngôn ngữ phù hợp với stack của bạn.

Cài đặt

CLI được xuất bản lên tất cả các registry gói lớn. Mỗi triển khai cung cấp các lệnh cốt lõi giống nhau.

Ngôn ngữ	Lệnh cài đặt	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

Xác minh cài đặt:

agentgif --version
agentgif --help

Xác thực

Trước khi tải lên hoặc quản lý GIF, xác thực với tài khoản GitHub của bạn:

agentgif login

Thao tác này mở trình duyệt của bạn cho GitHub OAuth. Sau khi ủy quyền, CLI lưu trữ API key của bạn cục bộ tại ~/.config/agentgif/config.json.

Hoặc, đặt API key trực tiếp:

agentgif login --api-key YOUR_API_KEY

Get your API key from Settings → API Key.

Kiểm tra trạng thái xác thực của bạn:

agentgif whoami
# → @yourname (authenticated)

Tải lên

Tải lên GIF với metadata:

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

Tùy chọn tải lên

Cờ	Mô tả
`--title`	Tiêu đề GIF (bắt buộc)
`--command`	Lệnh được trình diễn
`--tags`	Thẻ phân cách bằng dấu phẩy
`--description`	Văn bản mô tả
`--cast`	Đường dẫn đến tệp cast asciinema v2
`--shell`	Shell được dùng (bash, zsh, fish)
`--visibility`	`public` (mặc định) hoặc `unlisted`
`--open`	Mở trang GIF trong trình duyệt sau khi tải lên

Tải lên kèm tệp Cast

Kèm tệp cast cho phép lớp máy có thể đọc được cho tác nhân AI:

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

Ghi hình với 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

Tùy chọn ghi hình

Cờ	Mô tả
`--theme`	Terminal theme (see themes)
`--output`	Đường dẫn tệp đầu ra (mặc định: cùng tên với tape với đuôi .gif)
`--upload`	Tải lên ngay sau khi ghi hình
`--title`	Tiêu đề cho tải lên tự động
`--tags`	Thẻ cho tải lên tự động

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

Tìm kiếm

Tìm kiếm trên tất cả GIF công khai:

agentgif search "docker compose"

Đầu ra hiển thị ID GIF, tiêu đề, lệnh và số lượt xem trong bảng định dạng.

Bộ lọc tìm kiếm

# 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

Quản lý GIF

Danh sách GIF của bạn

agentgif list
agentgif list --limit 50

Xem chi tiết GIF

agentgif info xK9mQ2pL

Chỉnh sửa GIF

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

Xóa GIF

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

Cấu hình

CLI lưu trữ cấu hình tại ~/.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
}

Biến môi trường

Biến môi trường ghi đè cài đặt tệp cấu hình:

Biến	Mô tả
`AGENTGIF_API_KEY`	API key (ghi đè cấu hình)
`AGENTGIF_API_URL`	URL gốc API
`AGENTGIF_THEME`	Theme VHS mặc định

Hữu ích trong pipeline CI/CD:

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

← Quay lại Tài liệu · Hướng dẫn nhúng →