Install the VB-OS Python SDK

Requirements

• Python 3.10 or later
• pip (or any PEP 517-compatible installer)

Install the SDK

pip install "vb-os"

This installs the core SDK and its dependencies.

Install with CLI

To include the vbos command-line tool:

pip install "vb-os[cli]"

The CLI extra adds:

Dependency	Version	Purpose
click	>=8.1.0	Command framework
keyring	>=25.0.0	Credential storage
cryptography	>=43.0.0	Token encryption
tomli_w	>=1.0.0	Config file writing

After installation, the vbos command is available:

vbos --help

Verify the installation

import vbos

client = vbos.VBOSClient(api_key="vbos_your_key_here")
user = client.users.me()
print(user)
client.close()

Package structure

The SDK exposes two importable packages:

• vbos – the SDK library (client classes, models, exceptions)
• vbos_cli – the CLI application (only available with the cli extra)

All SDK imports use the vbos package:

from vbos import VBOSClient, AsyncVBOSClient
from vbos.models import EvaluationResult, ReplayResult
from vbos.exceptions import VBOSError, VBOSNotFoundError

Upgrading

pip install --upgrade "vb-os"

Or with CLI:

pip install --upgrade "vb-os[cli]"