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

# setup

> Configure the CLI itself, update it, install plugins, and generate shell completions.

To try the sample agent see [Try the sample agent](/sample-agent); for plugin setup see [Coding-agent plugins](/plugins).

## `relai info`

Print installed CLI information.

```sh theme={"system"}
relai info
```

Read-only.

## `relai setup`

Configure machine-level preferences and RELAI API credentials.

```sh theme={"system"}
relai setup [OPTIONS]
```

Create or manage keys from the [API keys page](https://platform.relai.ai/settings/workspace/api-keys) before running non-interactive setup.

RELAI supports Python agents, plus TypeScript and Go agents experimentally. `relai setup --check` audits universal as well as language-specific requirements for Python and TypeScript. Missing tools do not prevent setup from saving CLI preferences.

| Option                | Description                                              |
| --------------------- | -------------------------------------------------------- |
| `--check`             | Print prerequisite status without writing configuration. |
| `--theme {THEME}`     | Save CLI color theme. Values: `light`, `dark`.           |
| `--api-url {API_URL}` | Save the RELAI API URL.                                  |
| `--api-key {API_KEY}` | Save the RELAI API key.                                  |

```sh theme={"system"}
relai setup
relai setup --check
relai setup --theme dark
relai setup --api-url https://api.relai.ai --api-key {key}
```

By default, writes `~/.relai/config.toml` and local plugin marketplaces under `~/.relai/plugins/`. Do not paste or commit API keys.

Common failures: invalid credentials, missing required tools, non-interactive runs without enough flags, or permission issues writing home-directory config.

## `relai update`

Update the installed CLI to the latest release.

```sh theme={"system"}
relai update
relai update --force
```

Use `--force` to reinstall even when the current version already matches the latest release.

Common failures: unsupported platform, missing release artifact, network failure, checksum failure, or permission issues replacing the binary.

## `relai plugins install`

Install or refresh local RELAI plugin marketplaces for coding agents.

```sh theme={"system"}
relai plugins install
relai plugins install --agent codex
relai plugins install --agent claude
```

| Option            | Description                                                               |
| ----------------- | ------------------------------------------------------------------------- |
| `--agent {AGENT}` | Marketplace to install. Values: `all`, `codex`, `claude`. Default: `all`. |

Writes under `~/.relai/plugins/` and prints follow-up commands for Codex or Claude Code. It does not modify those tools unless you run the printed commands.

## `relai completions`

Generate shell completion scripts.

```sh theme={"system"}
relai completions bash
relai completions zsh
relai completions fish
```

Prints the completion script to stdout. It is read-only unless you redirect the output into a shell config path.