Install the VB-OS CLI

The VB-OS CLI (vbos) is distributed as an optional extra of the vb-os Python package.

Prerequisites

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

Install

pip install "vb-os[cli]"

This installs the core vb-os SDK plus the CLI dependencies:

Dependency	Purpose
click>=8.1.0	Command-line framework
keyring>=25.0.0	Secure credential storage
cryptography>=43.0.0	Token and credential handling
tomli_w>=1.0.0	TOML config file writing

The core SDK includes additional dependencies for HTTP communication and response validation.

Verify Installation

vbos --help

You should see the top-level help output listing all available command groups.

Shell Completions

Generate completion scripts for your shell:

# Bash
vbos completions bash >> ~/.bashrc

# Zsh
vbos completions zsh >> ~/.zshrc

# Fish
vbos completions fish > ~/.config/fish/completions/vbos.fish

Restart your shell or source the file to enable tab completion.

Configuration File

The CLI stores configuration in ~/.vbos/config (TOML format). Profiles are scoped under profile.<name>. Available config keys:

Key	Description
default-project	Default project slug
default-environment	Default environment name
default-org	Default organization ID
credential-store	keychain or file
api-url	API base URL (default: https://api.vb-os.org)
email	User email

Set values with:

vbos config set default-project my-project
vbos config get default-project
vbos config list

Global Options

Every command accepts these flags:

Option	Description
--profile	Config profile name
--format	Output format: json (default) or table
--cloud	Force cloud execution mode
--local	Force local execution mode

Next Steps

After installation, authenticate with your account.