Vendo CLI

Command-line interface — Manage apps, sources, integrations, jobs, and models directly from your terminal.

Installation


npm install -g vendo-cli

Requires Node.js 18 or later.

Authentication

Authenticate with your Vendo account via browser-based login:


vendo login

This opens your browser, where you select an account and authorize the CLI. An API key is created and stored locally at ~/.config/vendo/config.json.

To check which account you’re authenticated as:


vendo whoami

To remove stored credentials:


vendo logout

Multiple Accounts

The CLI supports multiple account profiles. Each vendo login saves a named profile (keyed by account slug). Switch between them:


vendo config list                # See all profiles
vendo config use <profile>       # Switch active profile
vendo status --profile <name>    # Use a profile for one command

Commands

Account Health


vendo status

Shows a summary of your account: active apps, sources, integrations, recent job failures, and sync health.

Identity


vendo whoami

Shows the current authenticated account name, slug, and API key ID.

Apps


vendo apps list                  # List all app connections
vendo apps get <appId>           # Get app details
vendo apps pause <appId>         # Pause an app
vendo apps resume <appId>        # Resume a paused app
vendo apps delete <appId>        # Delete an app (confirms first)

Sources


vendo sources list               # List all data sources
vendo sources get <sourceId>     # Get source details
vendo sources sync <sourceId>    # Trigger a manual sync
vendo sources sync <id> --watch  # Sync and wait for completion
vendo sources pause <sourceId>   # Pause a source
vendo sources resume <sourceId>  # Resume a paused source
vendo sources delete <sourceId>  # Delete a source (confirms first)

Integrations


vendo integrations list                     # List all integrations
vendo int get <integrationId>               # Get details (short alias)
vendo int sync <integrationId>              # Trigger a manual sync
vendo int sync <id> --watch                 # Sync and wait for completion
vendo int pause <integrationId>             # Pause an integration
vendo int resume <integrationId>            # Resume an integration
vendo int delete <integrationId>            # Delete an integration (confirms first)

Jobs


vendo jobs list                  # List sync jobs
vendo jobs list --status running # Filter by status
vendo jobs get <jobId>           # Get job details
vendo jobs cancel <jobId>        # Cancel a running/pending job (confirms first)
vendo jobs watch                 # Live polling dashboard

The watch command polls for running and pending jobs and refreshes automatically:


vendo jobs watch --interval 10   # Refresh every 10 seconds
vendo jobs watch --source <id>   # Filter by source

Catalog


vendo catalog list               # Browse available integration types
vendo catalog get <appType>      # Get details for a specific type

Models


vendo models list                # List data models
vendo models get <modelId>       # Get model details

Configuration


vendo config show                # Show current settings and profiles
vendo config set --api-key <key> # Set API key manually
vendo config set --base-url <url> # Override API base URL
vendo config use <profile>       # Switch active account profile
vendo config list                # List all account profiles
vendo config reset               # Delete all CLI configuration

Options

Global Flags

Flag	Description
`--profile <name>`	Use a specific account profile for this command
`--help`	Show help for any command
`-V, --version`	Show CLI version

Common Command Flags

Flag	Description
`--json`	Output raw JSON (useful for scripting and piping)
`--limit <n>`	Number of results (default: 20)
`--offset <n>`	Pagination offset
`-y, --yes`	Skip confirmation prompts (for delete/cancel commands)
`--watch`	Wait for job completion after triggering a sync

Examples

Scripting with JSON output


# Get all failed jobs as JSON
vendo jobs list --status failed --json | jq '.data[].id'
 
# Count active sources
vendo sources list --json | jq '.data | length'

Monitoring


# Watch running jobs in real-time
vendo jobs watch
 
# Quick health check
vendo status
 
# Check identity
vendo whoami

Trigger a sync and wait


# Sync and watch until complete
vendo sources sync abc123 --watch
 
# Or trigger and monitor separately
vendo sources sync abc123
vendo jobs list --source abc123

CI/CD Usage


# Non-interactive: set key via env and skip prompts
export VENDO_API_KEY=vendo_sk_...
vendo sources sync abc123 --watch --json
vendo apps delete old-app-id --yes

Shell Completions

Generate completions for your shell:


# Bash — add to ~/.bashrc
eval "$(vendo completions bash)"
 
# Zsh — add to ~/.zshrc
eval "$(vendo completions zsh)"
 
# Fish — save to completions directory
vendo completions fish > ~/.config/fish/completions/vendo.fish

Environment Variables

Variable	Description
`VENDO_API_KEY`	API key (overrides config file and profiles)
`VENDO_API_URL`	Base URL (overrides config file)

Updating

The CLI checks for updates automatically and notifies you when a new version is available.


npm update -g vendo-cli

Next Steps

Authentication — Learn about API key management
API Overview — Use the REST API directly
MCP Server — Connect AI tools to Vendo