xevol CLI

Terminal client for Xevol content execution.

Use it to ingest content, run analysis (spikes), manage prompts, inspect usage, and work across personal/team workspaces.

Install

npm install -g xevol
# or
npx xevol
# or
brew install xevol/tap/xevol

Requires Node.js >= 20.

Quick start

# 1) Login (device flow)
xevol login

# 2) Add content from URL (all URLs ingest via /v1/add)
xevol add "https://youtube.com/watch?v=oOylEw3tPQ8"

# 3) Run analysis
xevol analyze <transcription-id> --prompt facts

# 4) View content
xevol view <transcription-id>

Workspace model

Xevol CLI supports workspace switching:

xevol workspace list
xevol workspace switch <workspace-id>

When a workspace is selected, CLI sends X-Workspace-Id automatically for workspace-aware API routes.

Command map

Auth

• xevol login — device auth flow (or --token for headless/CI)
• xevol logout — revoke token + clear local config
• xevol whoami — current authenticated account

Ingestion & content

• xevol add <url> — URL ingestion (YouTube + non-YouTube)
• xevol create [text] — create from text/file/url/stdin/editor
• xevol list — list transcriptions
• xevol view <id> — view summary/content
• xevol delete <id> — delete transcription
• xevol open <id> — open item in browser

Analysis & prompts

• xevol analyze <id> --prompt <promptId> — create/read spike output
• xevol stream <spikeId> — SSE stream spike content
• xevol resume <transcriptionId> — resume interrupted stream session
• xevol prompts ... — prompt CRUD/list/get

Usage, exports, locations

• xevol usage — plan + usage snapshot
• xevol export <id> --format json|markdown|text — export content locally
• xevol whereami — latest Xevol Coordinates location
• xevol locations — Xevol Coordinates history

Interface

• xevol tui — interactive terminal UI

Common flags

• --json machine-readable output
• --token <token> override auth token per command
• --no-color disable ANSI colors

Examples

# Add + analyze + stream
xevol add "https://youtube.com/watch?v=..." --analyze facts,summary --stream

# Create from file
xevol create --file notes.md --title "Research notes"

# List in JSON
xevol list --json

# Export markdown
xevol export <id> --format markdown --output summary.md

Config

CLI config is stored in:

• ~/.xevol/config.json

Includes token, API URL, selected workspace, and defaults.

Notes

• Execution environment unification is in progress across API/CLI/mobile.
• Workspace-aware resources already respect selected workspace context.
• Usage/limit reporting follows API-provided scope during rollout.

Development

bun install
bun run dev
bun run build
bun run typecheck
bun run lint