CLI

The @iris/cli package wraps the REST API for terminal use. Useful for uploading existing recordings, scripting CI workflows, and spot-checking context without opening the dashboard.

Install

npm install -g @iris/cli

Log in

iris login --api-url https://your-iris-server.example.com

Opens a browser tab for auth, then writes a token to ~/.iris/config.json. Drop --api-url if you’re using the hosted version.

Common commands

# Upload an existing screen recording and wait for processing
iris upload ~/Movies/screen.mov --wait

# List recent recordings
iris list

# Print structured context for a recording (or "latest")
iris context <recording-id>
iris context latest

# Search across summaries, transcripts, OCR text, and tags
iris search "deploy bug"

# Manage API keys
iris keys list
iris keys create --name "ci" --scopes read,write

Scripting

Pass --json to list, context, or search for machine-readable output suitable for piping into jq:

iris context latest --json | jq '.context.summary'

Headless auth

For CI environments where you can’t open a browser, set IRIS_API_KEY and IRIS_API_URL directly. The CLI uses those env vars over the saved config when both are present.

Found a gap or a typo? Open an issue or PR on GitHub.