CLI Reference
vai command-line interface documentation
CLI Reference
The vai CLI provides powerful command-line access to VirtuousAI for automation, scripting, and CI/CD integration.
Quick Install
pip install vai-clientuv pip install vai-clientpipx install vai-clientQuick Start
Verify Installation
vai --versionStart Using
vai connections list
vai templates list
vai sync run shopify-orders --connection my-shopifyKey Features
| Feature | Description |
|---|---|
| Device Flow Auth | Secure OAuth2 authentication via browser |
| Multiple Profiles | Switch between environments and orgs |
| JSON Output | Machine-readable output for scripting |
| Rich Tables | Beautiful formatted output for humans |
| Shell Completion | Tab completion for bash/zsh/fish |
CLI Sections
Installation
Detailed installation and setup instructions
Authentication
Configure auth, profiles, and tokens
Commands
Complete command reference with examples
Example: CI/CD Pipeline
# In GitHub Actions or similar
export VAI_API_KEY="${{ secrets.VAI_API_KEY }}"
# Run sync with JSON output for parsing
vai sync run shopify-orders \
--connection $CONNECTION_ID \
--output json \
| jq '.runId'Output Formats
vai connections list # Rich table (default)
vai connections list -o json # JSON for parsing
vai connections list -o quiet # IDs only for scripting