Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Install and configure the VLM Run CLI
typer, rich, and openai are base dependencies. A plain install includes the full CLI, including vlmrun gw.
pip install -U vlmrun
vlmrun --version
vlmrun config init
vlmrun config set --api-key "your-api-key"
~/.vlmrun/config.toml.
export VLMRUN_API_KEY="your-api-key"
export VLMRUN_BASE_URL="https://api.vlm.run/v1" # Optional
# Show current configuration
vlmrun config show
# Set values
vlmrun config set --api-key "your-api-key"
vlmrun config set --base-url "https://api.vlm.run/v1"
# Unset values
vlmrun config unset --api-key
vlmrun config unset --base-url
# Re-initialize (overwrite existing)
vlmrun config init --force
| Option | Description |
|---|---|
--api-key TEXT | API key (overrides config/env) |
--base-url TEXT | API base URL (overrides config/env) |
--debug | Enable debug mode |
-v, --version | Show version and exit |
--help | Show help and exit |
| Command | Description |
|---|---|
chat | Chat with Orion to process images, videos, and documents |
execute | Execute agents with files, skills, and structured output |
generate | Generate structured predictions from files |
executions | List and retrieve agent execution results |
predictions | List and retrieve prediction results |
files | Upload, list, retrieve, and delete files |
skills | Create, list, lookup, update, and download skills |
hub | Browse available domains and JSON schemas |
models | List supported models |
gateway | Run OpenAI-compatible OCR / VLM models on the VLM Run Gateway (alias gw) |
config | Manage CLI configuration |
# Install completion
vlmrun --install-completion
# Show completion script (to customize)
vlmrun --show-completion