CLI

Create interviews, view responses, and retrieve synthesis from the terminal. Built with Ink for a rich interactive experience.

Install

# From the repository
cd cli && npm install && npm run build

# Run directly during development
npx tsx src/index.tsx

Authentication

Generate an agent token from the Roux dashboard, then log in:

roux login
# Paste your agent token when prompted

# Or set via environment variable
export ROUX_TOKEN=roux_...

Commands

Interviews

# List all interviews
roux interviews

# Get details for an interview
roux interviews get <id>

# Create a new interview (interactive)
roux interviews create

# Activate a draft
roux interviews activate <id>

Responses

# View all responses for an interview
roux responses <interview-id>

Synthesis

# View synthesis themes and insights
roux synthesis <interview-id>

Account

# Check token status
roux whoami

# Show help
roux --help

Environment variables

VariableDescription
ROUX_TOKENAgent token. Overrides the saved config.
ROUX_HOSTAPI host. Defaults to https://roux.link

Configuration

Credentials are stored in ~/.config/roux/config.json with file permissions restricted to the current user.