CLI स्थापना और उपयोग

AgentGIF CLI आपको अपने terminal से terminal 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.

अपनी auth स्थिति जांचें:

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`	asciinema v2 cast फ़ाइल का पथ
`--shell`	उपयोग किया गया shell (bash, zsh, fish)
`--visibility`	`public` (डिफ़ॉल्ट) या `unlisted`
`--open`	अपलोड के बाद अपने ब्राउज़र में GIF पेज खोलें

Cast फ़ाइल के साथ अपलोड करें

Cast फ़ाइल शामिल करने से AI एजेंटों के लिए मशीन-पठनीय परत सक्षम होती है:

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"

आउटपुट एक स्वरूपित तालिका में GIF ID, शीर्षक, कमांड और व्यू संख्या दिखाता है।

खोज फ़िल्टर

# 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
}

पर्यावरण चर

पर्यावरण चर config फ़ाइल सेटिंग को ओवरराइड करते हैं:

चर	विवरण
`AGENTGIF_API_KEY`	API कुंजी (config को ओवरराइड करती है)
`AGENTGIF_API_URL`	API आधार URL
`AGENTGIF_THEME`	डिफ़ॉल्ट VHS थीम

CI/CD पाइपलाइन में उपयोगी:

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

← दस्तावेज़ीकरण पर वापस · Embed गाइड →