vidcap-cli
v1.0.2
Published
CLI tool for VidCap.xyz API - YouTube video transcription and summarization
Maintainers
Readme
vidcap-cli
CLI tool for VidCap.xyz API - YouTube video transcription and summarization.
Installation
npm install -g vidcap-cliSetup
Set your API key (get one from vidcap.xyz):
# Option 1: Environment variable (recommended)
export VIDCAP_API_KEY=vcp_xxxxx
# Option 2: Config file
vidcap config set apiKey vcp_xxxxxUsage
YouTube Commands
# Get video information
vidcap youtube info "https://youtube.com/watch?v=xxx"
# Get video transcript/captions
vidcap youtube caption "https://youtube.com/watch?v=xxx" --locale en
# Get AI-generated summary
vidcap youtube summary "https://youtube.com/watch?v=xxx" --model gpt-4o
# Get summary with custom prompt
vidcap youtube summary-custom "https://youtube.com/watch?v=xxx" --prompt "Extract key points"
# Take screenshot at timestamp
vidcap youtube screenshot "https://youtube.com/watch?v=xxx" --second 30
# Take multiple screenshots
vidcap youtube screenshots "https://youtube.com/watch?v=xxx" --seconds 10 30 60
# Get video comments
vidcap youtube comments "https://youtube.com/watch?v=xxx" --order relevance
# Search YouTube videos
vidcap youtube search "typescript tutorial" --max 10 --order relevance
# Get available media formats
vidcap youtube media "https://youtube.com/watch?v=xxx"
# Download video
vidcap youtube download "https://youtube.com/watch?v=xxx"Video Commands
# Get video by internal ID
vidcap video get <video-id>AI Commands
# List available AI models
vidcap ai modelsConfig Commands
# Set config value
vidcap config set apiKey vcp_xxxxx
vidcap config set defaultLocale es
vidcap config set defaultModel gpt-4o
# Get config value
vidcap config get apiKey
# List all config
vidcap config listUpdate
# Update to latest version
vidcap update
# Check for updates only
vidcap update --checkGlobal Options
--json- Output results as JSON (useful for scripting)--verbose- Show detailed output--debug- Enable debug mode-v, --version- Show version-h, --help- Show help
Output Formats
Human-readable (default)
vidcap youtube info "https://youtube.com/watch?v=xxx"JSON (for scripting)
vidcap youtube info "https://youtube.com/watch?v=xxx" --json | jq .titleEnvironment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| VIDCAP_API_KEY | API key for authentication | - |
| VIDCAP_BASE_URL | API base URL | https://vidcap.xyz/api/v1 |
| VIDCAP_TIMEOUT | Request timeout (ms) | 120000 |
| VIDCAP_LOCALE | Default language | en |
| VIDCAP_MODEL | Default AI model | - |
Exit Codes
| Code | Description |
|------|-------------|
| 0 | Success |
| 1 | User/validation error |
| 2 | API error |
Examples
Scripting
# Get video title
TITLE=$(vidcap youtube info "$URL" --json | jq -r '.title')
# Process multiple videos
for url in "${URLS[@]}"; do
vidcap youtube summary "$url" --json >> summaries.json
donePipeline
# Search and summarize first result
URL=$(vidcap youtube search "topic" --json | jq -r '.items[0].url')
vidcap youtube summary "$URL"License
MIT
