Skip to content

CLI

Ask questions, manage audiences, and explore projects — all from your terminal.

The OriginalVoices CLI (ov) gives you direct access to Digital Twins without writing any integration code.

Installation

bash
npm install -g @originalvoices/cli

Requires Node.js 18+.

Authentication

Get your API key from platform.originalvoices.ai, then log in:

bash
ov auth login

You'll be prompted to enter your key. Alternatively, pass it directly:

bash
ov auth login --key ov_live_your_key_here

The key is stored in ~/.ov/config.json with restricted file permissions.

You can also set the OV_API_KEY environment variable — it takes priority over the config file:

bash
export OV_API_KEY=ov_live_your_key_here

Check auth status

bash
ov auth status

Log out

bash
ov auth logout

Asking Questions

The ov ask command supports three modes: open-ended questions, multiple choice, and project-scoped questions.

Open-ended (default)

bash
ov ask "What frustrates you about project management tools?" \
  --audience "US, 25-45, tech professionals"

Ask multiple questions at once:

bash
ov ask "What do you look for in a running shoe?" "How much do you typically spend?" \
  --audience "UK, 18-30, fitness enthusiasts"

Sample size

Control how many Digital Twins respond with --sample-size:

bash
ov ask "What matters most when choosing a bank?" \
  --audience "US, 30-50, homeowners" \
  --sample-size high

Options: low, medium (default), high, very_high

Multiple choice

bash
ov ask "Which feature matters most?" \
  --audience "US, 25-45, tech professionals" \
  --type choices \
  --choices "Price,Ease of use,Integrations,Support"

Allow multiple selections:

bash
ov ask "Which features do you use?" \
  --audience "US, 25-45, tech professionals" \
  --type choices \
  --choices "Dashboard,Reports,API,Webhooks" \
  --multiple-choice

Project mode

Query Digital Twins within a specific project:

bash
ov ask "How often do you use navigation apps?" \
  --project your-project-id

Filter to a subset of respondents:

bash
ov ask "What would make you switch apps?" \
  --project your-project-id \
  --filter "people who use navigation apps daily"

Managing Audiences

Save audience definitions to reuse across questions.

List audiences

bash
ov audiences list

Create an audience

bash
ov audiences create \
  --title "US Tech Professionals" \
  --prompt "US, 25-45, tech professionals working remotely"

Use a saved audience

bash
ov ask "What's your biggest productivity blocker?" \
  --audience-id your-audience-id

Update an audience

bash
ov audiences update your-audience-id --title "US Remote Tech Workers"

Delete an audience

bash
ov audiences delete your-audience-id

Exploring Projects

bash
ov projects list

JSON Output

Add --json to any command for machine-readable output. Useful for scripting and piping with jq:

bash
ov ask "What matters most when choosing a bank?" \
  --audience "US, 30-50, homeowners" \
  --json | jq '.answers'
bash
ov audiences list --json

Command Reference

CommandDescription
ov auth loginAuthenticate with your API key
ov auth statusShow current auth status
ov auth logoutClear stored credentials
ov ask <questions...>Ask questions to Digital Twins
ov audiences listList saved audiences
ov audiences createCreate a saved audience
ov audiences update <id>Update an audience title
ov audiences delete <id>Delete an audience
ov projects listList available projects

Next Steps

Powered by OriginalVoices