> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vlm.run/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Install and configure the VLM Run CLI

The VLM Run CLI (`vlmrun`) lets you interact with the VLM Run platform directly from your terminal — chat with Orion, generate structured predictions, manage files and skills, and more.

## Installation

The CLI is included with the VLM Run Python SDK. For the full experience with rich terminal output, install with the `cli` extra:

```bash theme={"theme":{"light":"github-light","dark":"dark-plus"}}
# Basic installation
pip install vlmrun

# Full CLI with rich terminal output (recommended)
pip install vlmrun[cli]
```

Verify the installation:

```bash theme={"theme":{"light":"github-light","dark":"dark-plus"}}
vlmrun --version
```

## Configuration

### Quick Setup

Initialize a config file and set your API key:

```bash theme={"theme":{"light":"github-light","dark":"dark-plus"}}
vlmrun config init
vlmrun config set --api-key "your-api-key"
```

Configuration is stored at `~/.vlmrun/config.toml`.

### Environment Variables

Alternatively, set your API key via environment variables:

```bash theme={"theme":{"light":"github-light","dark":"dark-plus"}}
export VLMRUN_API_KEY="your-api-key"
export VLMRUN_BASE_URL="https://api.vlm.run/v1"  # Optional
```

### Managing Config

```bash theme={"theme":{"light":"github-light","dark":"dark-plus"}}
# 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
```

## Global Options

All commands accept these global options:

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

## Commands

| Command                           | Description                                              |
| --------------------------------- | -------------------------------------------------------- |
| [`chat`](/cli/chat)               | Chat with Orion to process images, videos, and documents |
| [`execute`](/cli/execute)         | Execute agents with files, skills, and structured output |
| [`generate`](/cli/generate)       | Generate structured predictions from files               |
| [`executions`](/cli/executions)   | List and retrieve agent execution results                |
| [`predictions`](/cli/predictions) | List and retrieve prediction results                     |
| [`files`](/cli/files)             | Upload, list, retrieve, and delete files                 |
| [`skills`](/cli/skills)           | Create, list, lookup, update, and download skills        |
| [`hub`](/cli/hub)                 | Browse available domains and JSON schemas                |
| [`models`](/cli/models)           | List supported models                                    |
| [`config`](/cli/config)           | Manage CLI configuration                                 |

## Shell Completion

Install tab completion for your shell:

```bash theme={"theme":{"light":"github-light","dark":"dark-plus"}}
# Install completion
vlmrun --install-completion

# Show completion script (to customize)
vlmrun --show-completion
```