​
Command Line Interface

The VLM Run CLI provides command-line access to VLM Run functionality.

​
Global Options

Usage: vlmrun [OPTIONS] COMMAND [ARGS]...

 CLI for VLM Run (https://app.vlm.run)

Options
 --base-url                    TEXT  Base URL. Defaults to environment variable VLMRUN_BASE_URL
                                     [env var: VLMRUN_BASE_URL]
                                     [default: None]
 --api-key                     TEXT  API Key. Defaults to environment variable VLMRUN_API_KEY
                                     [env var: VLMRUN_API_KEY]
                                     [default: None]
 --debug                             Enable debug mode
 --version             -v            Show version and exit.
 --install-completion                Install completion for the current shell.
 --show-completion                   Show completion for the current shell, to copy it or customize the
                                     installation.
 --help                              Show this message and exit.

Commands
 datasets      Dataset operations
 files         File operations
 fine-tuning   Fine-tuning operations
 generate      Generation operations
 hub           Hub operations
 models        Model operations
 predictions   Predictions API commands

​
Available Commands

  • files - File management commands
  • models - Model operations
  • generate - Generate predictions
  • hub - Domain and schema management
  • datasets - Dataset operations
  • fine-tuning - Model fine-tuning

​
Example Usage

List available models:

vlmrun models list

Upload a file:

vlmrun files upload image.jpg

Generate predictions:

vlmrun generate image image.jpg --domain document.invoice

​
Environment Variables

  • VLMRUN_API_KEY - Your API key
  • VLMRUN_BASE_URL - API base URL (optional)