> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aris247.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Overview

> Developer tools for setup, testing, and configuration from your terminal.

# CLI Overview

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

## Install

```bash theme={null}
npm install -g @aris/cli
```

Or run any command directly with `npx`:

```bash theme={null}
npx @aris/cli <command>
```

## Setup

Set your API key:

```bash theme={null}
export ARIS_API_KEY=aris_yourkey
```

## Commands

<CardGroup cols={2}>
  <Card title="aris init" icon="rocket" href="/docs/cli/init">
    Interactive setup — framework detection, embed snippet, MCP config
  </Card>

  <Card title="aris test" icon="circle-check" href="/docs/cli/test">
    Validate connection — API key, IDX, listing search
  </Card>

  <Card title="aris config" icon="gear" href="/docs/cli/config">
    View or update widget settings
  </Card>

  <Card title="aris whoami" icon="user" href="/docs/cli/whoami">
    Show account and connection info
  </Card>
</CardGroup>

## Environment variables

| Variable            | Description                            |
| ------------------- | -------------------------------------- |
| `ARIS_API_KEY`      | **Required.** Your developer API key   |
| `ARIS_BROKERAGE_ID` | Brokerage ID (skips the `init` prompt) |
| `ARIS_BASE_URL`     | Override the API endpoint              |