Skip to content
VB-OSVB-OSVB-OS Docs

VB-OS CLI Command Reference

All commands support --format json|table, --profile, --cloud, and --local global options. List commands accept --limit, --cursor, and --all (fetch all pages). Destructive commands accept --confirm to skip prompts.

Verify & Replay

Section titled “Verify & Replay”
Command Description Key Flags
vbos verify Submit workload for evaluation --workload FILE, --project, --environment, --boundary, --batch, --idempotency-key
vbos replay EVALUATION_ID Replay a prior evaluation --project

The --workload flag accepts a file path or - for stdin. Use --local for local execution mode.

Terminal window
# Verify from file
vbos verify --workload payload.json --project my-project


# Verify from stdin
cat payload.json | vbos verify --workload - --project my-project


# Batch verify
vbos verify --workload batch.json --project my-project --batch


# Replay
vbos replay eval_abc123 --project my-project

Evaluations

Section titled “Evaluations”
Command Description Key Flags
vbos evaluations list List evaluations --project, --decision, --since, --until, --boundary
vbos evaluations get EVALUATION_ID Get evaluation detail --project
vbos evaluations search Search evaluations --project, --query
vbos evaluations export Request data export --project
vbos evaluations share EVALUATION_ID Create share link --project
vbos evaluations replay-analysis BOUNDARY_REF VERSION_ID Trigger replay analysis for boundary version --project
Terminal window
vbos evaluations list --project my-project --decision ASSERT --since 2025-01-01
vbos evaluations get eval_abc123 --project my-project

Boundaries

Section titled “Boundaries”
Command Description Key Flags
vbos boundaries create Create boundary --project, --name, --ref, --source FILE
vbos boundaries list List boundaries --project
vbos boundaries get BOUNDARY_ID Get boundary --project
vbos boundaries update BOUNDARY_ID Update boundary --project, --name
vbos boundaries archive BOUNDARY_ID Archive boundary --project
vbos boundaries compile Compile DSL source locally --source FILE
vbos boundaries validate Validate boundary against workload --source FILE, --workload FILE
vbos boundaries diff BOUNDARY_ID Diff two versions --project, --v1, --v2
vbos boundaries promote BOUNDARY_REF Promote to environment --version, --environment, --project
Terminal window
vbos boundaries create --project my-project --name "KYC Check" --ref kyc-check --source kyc.vbl
vbos boundaries compile --source kyc.vbl
vbos boundaries validate --source kyc.vbl --workload sample.json

Boundary Versions

Section titled “Boundary Versions”
Command Description Key Flags
vbos boundaries versions create BOUNDARY_ID Create version --project, --source FILE
vbos boundaries versions list BOUNDARY_ID List versions --project
vbos boundaries versions get BOUNDARY_ID VERSION_ID Get version --project
vbos boundaries versions update BOUNDARY_ID VERSION_ID Update version --project, --source FILE
vbos boundaries versions submit BOUNDARY_ID VERSION_ID Submit for review --project
vbos boundaries versions approve BOUNDARY_ID VERSION_ID Approve version --project
vbos boundaries versions reject BOUNDARY_ID VERSION_ID Reject version --project

Projects

Section titled “Projects”
Command Description Key Flags
vbos projects create Create project --name, --workspace
vbos projects list List projects
vbos projects get PROJECT_ID Get project detail
vbos projects update PROJECT_ID Update project --name
vbos projects archive PROJECT_ID Archive project
vbos projects delete PROJECT_ID Delete project --confirm

Project Members

Section titled “Project Members”
Command Description Key Flags
vbos projects members list PROJECT_ID List members
vbos projects members add PROJECT_ID Add member --user, --role
vbos projects members remove PROJECT_ID Remove member --user, --confirm

Environments

Section titled “Environments”
Command Description Key Flags
vbos environments create Create environment --project, --name
vbos environments list List environments --project
vbos environments get ENV_ID Get environment --project
vbos environments update ENV_ID Update environment --project, --name
vbos environments archive ENV_ID Archive environment --project
vbos environments unarchive ENV_ID Unarchive environment --project

Deployments

Section titled “Deployments”
Command Description Key Flags
vbos deployments list List deployments --project, --environment
vbos deployments get DEPLOYMENT_ID Get deployment --project, --environment
vbos deployments active Get active deployment --project, --environment
vbos deployments promote Promote boundary version --project, --from, --to, --version
vbos deployments rollback DEPLOYMENT_ID Rollback deployment --project, --environment, --confirm
vbos deployments approve DEPLOYMENT_ID Approve deployment --project, --environment
vbos deployments reject DEPLOYMENT_ID Reject deployment --project, --environment
Terminal window
vbos deployments active --project my-project --environment production
vbos deployments promote --project my-project --from staging --to production --version ver_abc123

API Keys

Section titled “API Keys”
Command Description Key Flags
vbos keys create Create API key --project, --environment, --name, --scopes
vbos keys list List API keys --project, --environment
vbos keys get KEY_ID Get API key --project, --environment
vbos keys rotate KEY_ID Rotate API key --project, --environment
vbos keys revoke KEY_ID Revoke API key --project, --environment, --confirm

Certifications

Section titled “Certifications”
Command Description Key Flags
vbos certify Initiate certification run --project, --environment, --model, --evidence FILE
vbos certifications list List runs --project
vbos certifications get RUN_ID Get run --project
vbos certifications report RUN_ID Download report --project, --output FILE
vbos certifications revoke RUN_ID Cancel run --project

Certification Models

Section titled “Certification Models”
Command Description Key Flags
vbos certification-models create Create model --project, --name, --config FILE
vbos certification-models list List models --project
vbos certification-models get MODEL_ID Get model --project
vbos certification-models update MODEL_ID Update model --project, --config FILE
vbos certification-models delete MODEL_ID Delete model --project, --confirm

Connectors

Section titled “Connectors”
Command Description Key Flags
vbos connectors create Create connector --project, --provider, --config FILE
vbos connectors list List connectors --project
vbos connectors get CONNECTOR_ID Get connector --project
vbos connectors update CONNECTOR_ID Update connector --project, --config FILE
vbos connectors delete CONNECTOR_ID Delete connector --project, --confirm
vbos connectors test CONNECTOR_ID Test connectivity --project
vbos connectors gather CONNECTOR_ID Trigger evidence gathering --project
vbos connectors authorize CONNECTOR_ID OAuth authorize --project, --no-browser
vbos connectors disconnect CONNECTOR_ID Disconnect OAuth --project, --confirm
vbos connectors reconnect CONNECTOR_ID Reconnect OAuth --project, --no-browser
vbos connectors status CONNECTOR_ID Show connector status --project

Connector Providers

Section titled “Connector Providers”
Command Description
vbos connectors providers list List available providers
vbos connectors providers get PROVIDER Get provider detail

Flows

Section titled “Flows”
Command Description Key Flags
vbos flows create Create flow --project, --name, --definition FILE
vbos flows list List flows --project
vbos flows get FLOW_ID Get flow --project
vbos flows update FLOW_ID Update flow --project, --name
vbos flows delete FLOW_ID Delete flow --project, --confirm
vbos flows export FLOW_ID Export flow definition --project, --output FILE
vbos flows import Import flow --project, --file FILE
vbos flows from-template TEMPLATE_SLUG Create from template --project
vbos flows deploy FLOW_ID VERSION_ID Deploy flow version --project, --environment
vbos flows suspend DEPLOYMENT_ID Suspend deployment --project
vbos flows resume DEPLOYMENT_ID Resume deployment --project
vbos flows dry-run FLOW_ID VERSION_ID Execute dry run --project, --decision, --evidence FILE

Flow Versions

Section titled “Flow Versions”
Command Description Key Flags
vbos flows versions create FLOW_ID Create version --project, --definition FILE
vbos flows versions list FLOW_ID List versions --project
vbos flows versions get FLOW_ID VERSION_ID Get version --project
vbos flows versions update FLOW_ID VERSION_ID Update version --project, --definition FILE
vbos flows versions delete FLOW_ID VERSION_ID Delete version --project, --confirm
vbos flows versions approve FLOW_ID VERSION_ID Approve version --project

Flow Executions

Section titled “Flow Executions”
Command Description Key Flags
vbos flows executions list FLOW_ID List executions --project
vbos flows executions reconstruct FLOW_ID EXECUTION_ID Reconstruct execution --project

Flow Templates

Section titled “Flow Templates”
Command Description
vbos flows templates list List flow templates
vbos flows templates get SLUG Get flow template

Governed Workspaces

Section titled “Governed Workspaces”
Command Description Key Flags
vbos governed-workspaces provision Provision workspace --project, --config FILE
vbos governed-workspaces list List workspaces --project
vbos governed-workspaces get WORKSPACE_ID Get workspace --project
vbos governed-workspaces deploy WORKSPACE_ID Deploy version --project, --version VERSION_ID
vbos governed-workspaces evaluate WORKSPACE_ID Create and submit instance --project
vbos governed-workspaces seal WORKSPACE_ID Seal (archive) version --project, --version VERSION_ID
vbos governed-workspaces teardown WORKSPACE_ID Tear down workspace --project, --confirm

Named Sets

Section titled “Named Sets”
Command Description Key Flags
vbos named-sets list List named sets --project
vbos named-sets get SET_ID Get named set --project
vbos named-sets create Create named set --project, --name, --items FILE
vbos named-sets update SET_ID Update named set --project, --name, --items FILE
vbos named-sets delete SET_ID Delete named set --project, --confirm

Alert Rules

Section titled “Alert Rules”
Command Description Key Flags
vbos alert-rules create Create alert rule --project, --config FILE
vbos alert-rules list List alert rules --project
vbos alert-rules get RULE_ID Get alert rule --project
vbos alert-rules update RULE_ID Update alert rule --project, --config FILE
vbos alert-rules delete RULE_ID Delete alert rule --project, --confirm

Analytics

Section titled “Analytics”
Command Description Key Flags
vbos analytics assertion-rate View assertion rate --project, --since, --until, --environment

Webhooks

Section titled “Webhooks”
Command Description Key Flags
vbos webhooks create Create webhook --project, --url, --events, --org
vbos webhooks list List webhooks --project, --org
vbos webhooks get WEBHOOK_ID Get webhook --project
vbos webhooks update WEBHOOK_ID Update webhook --project, --url, --events
vbos webhooks delete WEBHOOK_ID Delete webhook --project, --confirm
vbos webhooks test WEBHOOK_ID Send test event --project
vbos webhooks rotate-secret WEBHOOK_ID Rotate signing secret --project
vbos webhooks deliveries WEBHOOK_ID List deliveries --project
vbos webhooks retry WEBHOOK_ID DELIVERY_ID Retry delivery --project

Organization

Section titled “Organization”
Command Description Key Flags
vbos org get Get organization
vbos org update Update organization --name
vbos org settings get Get org settings
vbos org settings update Update org settings --setting key=value (repeatable)

Members

Section titled “Members”
Command Description Key Flags
vbos members list List org members
vbos members invite Invite member --email, --role
vbos members role MEMBER_ID Set member role --role
vbos members suspend MEMBER_ID Suspend member
vbos members reactivate MEMBER_ID Reactivate member
vbos members remove MEMBER_ID Remove member --confirm

Audit Log

Section titled “Audit Log”
Command Description Key Flags
vbos audit-log list List audit log entries --since, --until, --actor, --action
vbos audit-log export Export audit log --since, --until
vbos audit-log export-status EXPORT_ID Check export status

Templates

Section titled “Templates”
Command Description Key Flags
vbos templates list List templates --domain
vbos templates get SLUG Get template
vbos templates fork SLUG Fork template into project --project, --name

Notifications

Section titled “Notifications”
Command Description Key Flags
vbos notifications list List notifications --project
vbos notifications read NOTIFICATION_ID Mark as read --project
vbos notifications unread NOTIFICATION_ID Mark as unread --project

Account

Section titled “Account”
Command Description Key Flags
vbos account delete Delete account --confirm
vbos account delete-status Check deletion status
vbos account delete-cancel Cancel deletion
vbos account export Request data export
vbos account export-status Check export status --export-id

Workspaces

Section titled “Workspaces”
Command Description Key Flags
vbos workspaces list List workspaces
vbos workspaces get WORKSPACE_ID Get workspace
vbos workspaces create Create workspace --name, --description
vbos workspaces update WORKSPACE_ID Update workspace --name, --description
vbos workspaces archive WORKSPACE_ID Archive workspace --confirm

Configuration

Section titled “Configuration”
Command Description
vbos config set KEY VALUE Set config value
vbos config get KEY Get config value
vbos config list List all config values
vbos completions bash|zsh|fish Generate shell completion scripts