Skip to main content

CLI Overview

The ARIS CLI (@aris/cli) provides developer tools for setup, testing, and configuration from your terminal.

Install

npm install -g @aris/cli
Or run any command directly with npx:
npx @aris/cli <command>

Setup

Set your API key:
export ARIS_API_KEY=aris_yourkey

Commands

aris init

Interactive setup — framework detection, embed snippet, MCP config

aris test

Validate connection — API key, IDX, listing search

aris config

View or update widget settings

aris whoami

Show account and connection info

Environment variables

VariableDescription
ARIS_API_KEYRequired. Your developer API key
ARIS_BROKERAGE_IDBrokerage ID (skips the init prompt)
ARIS_BASE_URLOverride the API endpoint