Resource Management

The VoiceRun CLI provides commands for managing all platform resources: agents, functions, environments, secrets, phone numbers, telephony providers, and templates.

Listing Resources#

Use vr get to list resources:

vr get agents                     # List all agents
vr get functions <agent>          # List functions for an agent
vr get environments <agent>       # List environments for an agent
vr get secrets                    # List organization secrets
vr get secrets --agent <agent>    # Include agent-level secrets
vr get phonenumbers               # List organization phone numbers
vr get telephony                  # List telephony providers
vr get assignments <agent>        # List phone number assignments
vr get templates                  # List available templates

The <agent> argument accepts either an agent name or ID.

Viewing Resource Details#

Use vr describe to see detailed information about a specific resource:

vr describe agent <name-or-id>
vr describe function <agent> <name-or-id>
vr describe environment <agent> <name-or-id>
vr describe secret <name-or-id>
vr describe secret <name-or-id> --agent <agent>
vr describe phonenumber <id>
vr describe telephony <name-or-id>
vr describe assignment <agent> <assignment-id>

Creating Resources#

Secrets#

Create organization-level or agent-level secrets:

vr create secret API_KEY sk-abc123                  # Organization secret
vr create secret API_KEY sk-abc123 --agent my-agent # Agent secret

Phone Numbers#

vr create phonenumber --phone-number +15551234567           # Register existing number
vr create phonenumber --purchase --area-code 415            # Purchase new number
vr create phonenumber <telephony-id> --purchase -a 212 -c US  # From specific provider

Flag	Description
`--purchase`	Purchase a new number from the provider
`--area-code`, `-a`	Area code for the number
`--country-code`, `-c`	Country code (default: US)
`--friendly-name`, `-n`	Friendly name for the number
`--phone-number`, `-p`	Phone number to register (without `--purchase`)

Phone Number Assignments#

Assign a phone number to an agent environment:

vr create assignment <agent> <environment> <phone-number-id>
vr create assignment <agent> <environment> <phone-number-id> --configure

The --configure flag also configures the phone number with the telephony provider after assignment.

Telephony Providers#

Connect a Twilio or Telnyx account:

vr create telephony

Without flags, this runs interactively. You can also provide all values via flags:

vr create telephony --name "My Twilio" --provider-type twilio \
  --account-sid AC123 --api-key-sid SK123 --api-key-secret secret123

vr create telephony --name "My Telnyx" --provider-type telnyx --api-key KEY123

Templates#

Create a reusable template from your current project:

vr create template my-template
vr create template my-template --description "Restaurant booking agent" --category booking --public

Deleting Resources#

Use vr delete to remove resources:

vr delete agent <name-or-id>
vr delete function <agent> <name-or-id>
vr delete environment <agent> <name-or-id>
vr delete secret <name-or-id>
vr delete secret <name-or-id> --agent <agent>
vr delete phonenumber <name-or-id>
vr delete phonenumber <name-or-id> --release    # Release back to provider
vr delete telephony <name-or-id>
vr delete assignment <agent> <assignment-id>

The --release flag on vr delete phonenumber releases the number back to the telephony provider instead of just removing it from VoiceRun.