CLI Reference Complete reference for all VM0 CLI commands
Command Description Options vm0 infoDisplay environment information - vm0 initInitialize a new VM0 project with vm0.yaml -f, --force, -n, --name <name>vm0 onboardGuided setup for new VM0 users -y, --yes, --name <name>vm0 setup-claudeInstall vm0-cli skill for Claude -
Command Description Notes vm0 auth loginLog in to VM0 (opens browser) Use VM0_API_URL env var for custom API vm0 auth logoutLog out of VM0 - vm0 auth statusShow authentication status - vm0 auth setup-tokenOutput auth token for CI/CD environments -
Configure model providers for agent runs.
Command Description Options vm0 model-provider listList configured model providers - vm0 model-provider setupConfigure a model provider -t, --type <type>, -c, --credential <value>, --convertvm0 model-provider delete <type>Delete a model provider - vm0 model-provider set-default <type>Set a model provider as default for its framework -
# Interactive setup vm0 model-provider setup # Non-interactive setup vm0 model-provider setup --type anthropic-api-key --credential "sk-ant-xxx" # Convert existing credential to model provider vm0 model-provider setup --convert Store and manage secrets (sensitive data) for use in agent runs.
Command Description Options vm0 secret listList all stored secrets Alias: ls vm0 secret set <name> <value>Store a secret -d, --descriptionvm0 secret delete <name>Delete a secret -
# Store a secret vm0 secret set MY_API_KEY sk-xxx # Store with description vm0 secret set MY_API_KEY sk-xxx -d "OpenAI API key" # List all secrets (values are hidden) vm0 secret list # Delete a secret vm0 secret delete MY_API_KEY Store and manage variables (non-sensitive configuration) for use in agent runs.
Command Description Options vm0 variable listList all stored variables Alias: ls vm0 variable set <name> <value>Store a variable -d, --descriptionvm0 variable delete <name>Delete a variable -
# Store a variable vm0 variable set ENV_NAME production # Store with description vm0 variable set ENV_NAME production -d "Current environment" # List all variables vm0 variable list # Delete a variable vm0 variable delete ENV_NAME Scopes are namespaces for organizing agents.
Command Description Options vm0 scope statusShow current scope - vm0 scope set <slug>Set the active scope -
Command Description Options vm0 compose <agent-yaml>Create or update agent compose -y, --yesvm0 run <agent-name> <prompt>Run an agent See options table below vm0 run continue <session-id> <prompt>Continue from session (uses latest artifact) --env-file, --vars, --secrets, --volume-version, --model-providervm0 run resume <checkpoint-id> <prompt>Resume from checkpoint (uses snapshot data) --env-file, --vars, --secrets, --volume-version, --model-providervm0 run listList active runs (pending and running) Alias: ls vm0 run kill <run-id>Kill (cancel) a pending or running run - vm0 cook [prompt]Prepare and execute agent from vm0.yaml --env-file <path>, -y, --yesvm0 cook logsView logs from the last cook run Same as vm0 logs options vm0 cook continue <prompt>Continue from last session --env-file <path>vm0 cook resume <prompt>Resume from last checkpoint --env-file <path>vm0 agent listList all agent composes --jsonvm0 agent status <name[:version]>Show agent compose status --json
Option Description --env-file <path>Load environment variables from file --vars <KEY=value>Variables for ${{ vars.xxx }} (repeatable) --secrets <KEY=value>Secrets for ${{ secrets.xxx }} (repeatable) --artifact-name <name>Artifact storage name --artifact-version <hash>Artifact version hash (defaults to latest) --volume-version <name=version>Volume version override (repeatable) --conversation <id>Resume from conversation ID --model-provider <type>Override model provider
# Run latest version vm0 run my-agent "build a todo app" # Run specific version vm0 run my-agent:abc123 "build a todo app" # With variables and secrets vm0 run my-agent "deploy" \ --vars ENV=production \ --secrets API_KEY=sk-xxx # Load variables from file vm0 run my-agent "deploy" --env-file .env.production # Continue a session vm0 run continue 9907d243-c38a-442b-84ee-efefd4eaff44 "add authentication" # Resume from checkpoint vm0 run resume 61cddb1f-b83a-4b89-8785-97df099fe61f "try different approach" # Prepare artifact, compose and run agent based on vm0.yaml and AGENTS.md vm0 cook # Same as above with custom prompt vm0 cook "build a new feature" # Load environment variables from file vm0 cook "deploy" --env-file .env.production # View logs from the last run vm0 cook logs # Continue working from where you left off vm0 cook continue "add more features" # Resume from the last checkpoint vm0 cook resume "try a different approach" Command Description Options vm0 schedule setup <agent>Create or edit a schedule -f, -t, -d, -z, -p, --var, --secret, --artifact-name, -e, --enablevm0 schedule listList all schedules Alias: ls vm0 schedule status <agent>Show schedule details - vm0 schedule enable <agent>Activate a schedule - vm0 schedule disable <agent>Pause a schedule - vm0 schedule delete <agent>Remove a schedule -f, --force
Option Description -f, --frequency <type>Schedule frequency: daily, weekly, monthly, once -t, --time <HH:MM>Time to run (24-hour format) -d, --day <day>Day of week (mon-sun) or month (1-31) -z, --timezone <tz>IANA timezone -p, --prompt <text>Prompt to run --var <KEY=value>Pass variable (repeatable) --secret <KEY=value>Pass secret (repeatable) --artifact-name <name>Artifact name (default: artifact) -e, --enableEnable schedule immediately after creation
# Interactive setup vm0 schedule setup my-agent # Non-interactive daily schedule vm0 schedule setup my-agent \ --frequency daily \ --time 09:00 \ --prompt "run daily tasks" # Create and enable in one command vm0 schedule setup my-agent \ --frequency daily \ --time 09:00 \ --prompt "run daily tasks" \ --enable # List all schedules vm0 schedule list # Check status vm0 schedule status my-agent # Enable/disable vm0 schedule enable my-agent vm0 schedule disable my-agent # Delete with confirmation skip vm0 schedule delete my-agent --force Volumes provide persistent file storage defined in your compose configuration. Volume contents are not versioned after agent runs.
Command Description Options vm0 volume initInitialize volume in current directory --name <name>vm0 volume pushPush local files to cloud --message <msg>, --forcevm0 volume pull [versionId]Pull cloud files to local - vm0 volume statusShow volume status and changes - vm0 volume listList all remote volumes Alias: ls vm0 volume clone <name> [dest]Clone remote volume locally -
Artifacts are work products generated by agents during execution. Unlike volumes, artifacts are versioned after each run.
Command Description Options vm0 artifact initInitialize artifact in current directory --name <name>vm0 artifact pushPush local files to cloud --message <msg>, --forcevm0 artifact pull [versionId]Pull cloud artifact to local - vm0 artifact statusShow artifact status and changes - vm0 artifact listList all remote artifacts Alias: ls vm0 artifact clone <name> [dest]Clone remote artifact locally -
Command Description Options vm0 logs <runId>View logs for an agent run -a/--agent, -s/--system, -m/--metrics, -n/--network, --since, --tail, --head
Examples:
# View agent events (default) vm0 logs 11007483-20b2-42b1-8f2a-b42a10186810 # View system logs vm0 logs 11007483-20b2-42b1-8f2a-b42a10186810 --system # Show last 20 entries vm0 logs 11007483-20b2-42b1-8f2a-b42a10186810 --tail 20 # Show logs since 5 minutes ago vm0 logs 11007483-20b2-42b1-8f2a-b42a10186810 --since 5m Command Description Options vm0 usageView usage statistics --since <date>, --until <date>
Examples:
# View last 7 days (default) vm0 usage # View last 30 days vm0 usage --since 30d # View specific date range vm0 usage --since 2026-01-01 --until 2026-01-15
VM0_TOKEN - Authentication token for API accessVM0_API_URL - Custom API URL (defaults to https://www.vm0.ai )
VM0