Alvio CLI (@alvio/cli)

Official command-line interface for Alvio analytics, campaigns, and team-management operations.

Install

npm i -g @alvio/cli

Or run without installing:

npx @alvio/cli@latest --help

Quick start

alvio auth login "[email protected]" --open
# then complete with the code from email (if not entered interactively):
alvio auth login "[email protected]" --otp "123456"
alvio auth whoami
alvio analytics dashboard --phone "<business_phone>" --timezone "Europe/Paris"

Authentication model

• OTP first (recommended):
  • alvio auth login <email> sends a code by email
  • alvio auth login <email> --otp <code> verifies and stores session
• Token mode (headless agents):
  • alvio auth token set --token <jwt>

The CLI auto-discovers Supabase auth settings from your Alvio API (/api/auth/cli-config), so clients do not need to pass Supabase URL/keys manually in normal usage. The CLI API origin is fixed to https://www.alvio.ai.

Self-serve help

alvio help
alvio help errors
alvio help payloads
alvio help campaign create
alvio campaign create --help

Command families

• alvio auth ... (OTP login, token setup, identity)
• alvio analytics ... (dashboard, conversation metrics, revenue, compare, AI assistant)
• alvio campaign ... (campaign lifecycle, contacts, steps, A/B, templates, tests)
• alvio feedback ... (conversation/message feedback with workflow triggers)
• alvio team ... (members, phone assignments, access requests)
• alvio agents ... (agent metadata and characteristics)

Conversations and feedback

# Paginated campaign conversations (with server-side fetch cap)
alvio campaign conversations list "<campaign_id>" --page 1 --limit 25 --max-fetch 1000

# Full conversation details (messages, reactions, webhooks, media metadata)
alvio campaign conversations get "<campaign_id>" "<conversation_id>"

# Feedback on conversation or specific message
alvio feedback conversation "<conversation_id>" --rating positive --details "Very relevant answer"
alvio feedback message "<conversation_id>" "<message_id>" --rating negative --details "Wrong info in this reply"

Conversation-focused commands now include a conversation_url in their JSON output so agents can jump directly to the inbox thread.

Agent characteristics

# List accessible agents with structured characteristics bullets
alvio agents characteristics list

# Scope by phone number
alvio agents characteristics list --phone "33744315695"

# Scope by phone assignment config and keep modules only
alvio agents characteristics list --config-id 8 --module-only

Sequence step pause/resume

# Pause a step without deleting it (step is skipped at runtime)
alvio campaign steps pause "<campaign_id>" "<step_id>"

# Re-enable that step later
alvio campaign steps resume "<campaign_id>" "<step_id>"

Relative-date step scheduling (no-show reminders)

# Create a step scheduled 2 days before custom_fields.appointment_at
alvio campaign steps create "<campaign_id>" --json '{
  "name": "Reminder J-2",
  "template_body": "Bonjour {{contact_name}}, rappel: votre rendez-vous est dans 2 jours.",
  "delay_value": 2,
  "delay_unit": "days",
  "schedule_anchor_mode": "contact_field",
  "schedule_anchor_field": "custom_fields.appointment_at",
  "schedule_anchor_direction": "before"
}'

# Revert a step to classic delay after previous step
alvio campaign steps update "<campaign_id>" "<step_id>" --json '{
  "schedule_anchor_mode": "previous_step",
  "delay_value": 1,
  "delay_unit": "hours"
}'