Skip to content

VB-OS CLI Authentication

The VB-OS CLI supports interactive login (email/password with MFA), API key authentication, and environment variable configuration.

Terminal window
vbos login

This starts an interactive flow that handles email/password entry, MFA prompts, multi-organization selection, and Terms of Service acceptance. Credentials are stored securely in your system keyring.

To authenticate with a specific organization:

Terminal window
vbos login --org ORG_ID

To authenticate with an API token directly:

Terminal window
vbos login --token YOUR_TOKEN

For non-interactive use (scripts, CI/CD), set the VBOS_API_KEY environment variable:

Terminal window
export VBOS_API_KEY="vbos_key_..."
vbos verify --workload payload.json --project my-project

The precedence order is: VBOS_API_KEY environment variable, then stored keyring credentials.

By default, the CLI stores credentials in your system keychain (macOS Keychain, Windows Credential Locker, or a Linux Secret Service provider). To use file-based storage instead:

Terminal window
vbos config set credential-store file

Clear stored credentials:

Terminal window
vbos logout

If your account belongs to multiple organizations:

Terminal window
# Interactive selection
vbos switch-org
# Direct switch
vbos switch-org ORG_ID

If your email is not yet verified:

Terminal window
vbos resend-verification

Check your current identity:

Terminal window
vbos org get

This returns your current organization details, confirming credentials are valid.

Command Description
vbos login Authenticate (email/password, API key, MFA, multi-org)
vbos logout Sign out and clear stored credentials
vbos switch-org [ORG_ID] Switch organization (interactive if no ID given)
vbos resend-verification Resend email verification