Commands
Full CLI command reference
Commands
Complete reference for VAI CLI commands.
Global Options
All commands support these options:
| Option | Description |
|---|---|
-v, --version | Show CLI version |
-o, --output | Output format: table, json, quiet |
--help | Show help for any command |
auth
Authentication commands.
vai auth login # Authenticate via device flow
vai auth logout # Remove stored credentials
vai auth status # Show authentication status
vai auth token # Print current access token
# Profile management
vai auth profile list # List available profiles
vai auth profile current # Show active profile
vai auth profile select # Set default profileconnections
Manage external connections.
vai connections list # List all connections
vai connections get <id> # Get connection details
vai connections create # Create a new connection
vai connections delete <id> # Delete a connection
vai connections test <id> # Test connectionExamples
# List connections as JSON
vai connections list -o json
# Create a connection
vai connections create \
--name "My Shopify" \
--provider shopify \
--config '{"shop": "mystore.myshopify.com"}'
# Test a connection
vai connections test conn_abc123templates
Browse and manage templates.
vai templates list # List available templates
vai templates get <slug> # Get template details
vai templates categories # List template categoriesExamples
# List templates by category
vai templates list --category data-sync
# Get template details
vai templates get shopify-orders-syncsessions
Manage chat sessions.
vai sessions list # List recent sessions
vai sessions get <id> # Get session details
vai sessions messages <id> # List session messagessync
Data synchronization commands.
vai sync run <template> --connection <conn> # Run a sync
vai sync status <run-id> # Check sync status
vai sync history # View sync historyExamples
# Run a sync
vai sync run shopify-orders-sync \
--connection conn_abc123
# Check status
vai sync status run_xyz789tokens
Manage Personal Access Tokens.
vai tokens list # List your tokens
vai tokens create --name <name> # Create a new token
vai tokens revoke <id> # Revoke a tokenExamples
# Create a CI/CD token
vai tokens create --name "GitHub Actions"
# List tokens
vai tokens listorg
Organization management.
vai org list # List organizations
vai org current # Show current organization
vai org select <id> # Switch organizationusers
User management (admin only).
vai users list # List organization users
vai users invite <email> # Invite a user
vai users remove <id> # Remove a useractions
Manage action runs.
vai actions list # List action runs
vai actions get <run_id> # Get run details
vai actions run --kind <kind> # Create and execute an action
vai actions cancel <run_id> # Cancel a pending/running action
vai actions retry <run_id> # Retry a failed actionExamples
# Run a data extraction action
vai actions run \
--kind dlt_extract \
--definition '{"source": "shopify", "resources": ["orders"]}' \
--wait
# List failed actions
vai actions list --status failed
# Retry a failed action
vai actions retry run_abc123 --waitbundles
Discover and install bundles from the marketplace.
vai bundles list # List available bundles
vai bundles get <slug> # Get bundle details
vai bundles install <slug> # Install a bundleExamples
# List all bundles
vai bundles list
# Get bundle details and required inputs
vai bundles get shopify-bronze
# Install a bundle with inputs
vai bundles install shopify-bronze \
--input api_key=shpat_xxx \
--input shop_url=mystore.myshopify.comextract
High-level data extraction commands.
vai extract shopify # Extract from Shopify
vai extract salesforce # Extract from Salesforce
vai extract hubspot # Extract from HubSpotExamples
# Extract Shopify orders incrementally
vai extract shopify \
--connection prod-shopify \
--resources orders,products \
--incremental \
--wait
# Extract Salesforce data with date range
vai extract salesforce \
--connection sf-prod \
--resources accounts,contacts \
--start-date 2026-01-01 \
--waitruns
View and manage automation runs.
vai runs list # List automation runs
vai runs get <run_id> # Get run details
vai runs cancel <run_id> # Cancel a running automationExamples
# List runs for a specific automation
vai runs list --automation-id auto_abc123
# View run details
vai runs get run_xyz789doctor
Diagnose configuration issues.
vai doctor # Run diagnosticsThis checks:
- API connectivity
- Authentication status
- Configuration validity
- Network issues
Output Formats
Table (Default)
vai connections listConnections
┌──────────────────┬──────────┬─────────────────────┐
│ ID │ Name │ Provider │
├──────────────────┼──────────┼─────────────────────┤
│ conn_abc123 │ Shopify │ shopify │
│ conn_def456 │ Postgres │ postgresql │
└──────────────────┴──────────┴─────────────────────┘JSON
vai connections list -o json{
"items": [
{"id": "conn_abc123", "name": "Shopify", "provider": "shopify"},
{"id": "conn_def456", "name": "Postgres", "provider": "postgresql"}
]
}Quiet
vai connections list -o quietconn_abc123
conn_def456Useful for scripting:
for id in $(vai connections list -o quiet); do
vai connections test $id
done