TheDocumentation Index
Fetch the complete documentation index at: https://docs.vlm.run/llms.txt
Use this file to discover all available pages before exploring further.
vlmrun execute command submits agent executions via the /v1/agent/execute endpoint. Upload files, attach skills, and get structured JSON output.
Basic Usage
Agent Names
Use<agent-name>:<agent-version> format. If --name is omitted, the prompt is used to identify the agent.
Using Skills
Attach skills inline from a local directory or reference server-side skills by ID. Only one of--skill or --skill-id may be provided.
Models
| Model | Description |
|---|---|
vlmrun-orion-1:lite | Lightweight |
vlmrun-orion-1:fast | Speed-optimized |
vlmrun-orion-1:auto | Auto-select (default) |
vlmrun-orion-1:pro | Most capable |
Toolsets
Enable specific tool categories with--toolset (repeatable):
core, image, image-gen, world-gen, viz, document, video, web.
Async Execution
By default the CLI waits for execution to complete. Use--no-wait to submit and return immediately:
Output Formats
Prompt Sources
The prompt can be text or a path to a.txt/.md file:
Options Reference
| Option | Short | Description |
|---|---|---|
--name | -n | Agent name as <name>:<version> |
--prompt | -p | Prompt text or path to a .txt/.md file |
--input | -i | Input file (repeatable) |
--schema | Path to a JSON schema file for the response model | |
--skill | -k | Path to a local skill directory (repeatable) |
--skill-id | Server-side skill as <name>:<version> (repeatable) | |
--toolset | -t | Tool category to enable (repeatable) |
--model | -m | Model variant (default: vlmrun-orion-1:auto) |
--wait / --no-wait | Wait for completion (default: --wait) | |
--timeout | Timeout in seconds when waiting (default: 300) | |
--poll-interval | Seconds between status checks (default: 5) | |
--callback-url | Webhook URL called on completion | |
--format | -f | Output format (json) |