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

# CLI reference

> Install, inspect, repair, update, and remove the Recallium client

The `recallium` CLI connects supported coding agents to Recallium. It requires Node.js 18 or later.

## Install the CLI

```bash theme={null}
npm install -g recallium
```

Run `recallium` with no arguments in an interactive terminal to open the Install / Modify screen.

## Common commands

| Command                     | Purpose                                                           |
| --------------------------- | ----------------------------------------------------------------- |
| `recallium install`         | Detect coding agents, review the setup, connect them, and sign in |
| `recallium install --yes`   | Connect all detected agents without the interactive screen        |
| `recallium status`          | Show client, sign-in, server, and connected-agent state           |
| `recallium doctor`          | Run capture-health and integration checks                         |
| `recallium login`           | Sign in again or replace a lost or revoked Cloud credential       |
| `recallium enroll`          | Complete or retry a pending Cloud enrollment                      |
| `recallium logout`          | Sign out and remove local Cloud credentials                       |
| `recallium unauthorize`     | Sign out and remove the complete local Recallium home directory   |
| `recallium menu`            | Open the Install / Modify screen explicitly                       |
| `recallium diagnose`        | Open the interactive diagnostic screen                            |
| `recallium update`          | Update when a newer CLI version is available                      |
| `recallium uninstall`       | Open the Install / Modify screen and remove selected agents       |
| `recallium uninstall --all` | Remove all Recallium agent wiring and local Recallium state       |
| `recallium help`            | Show the current command and option list                          |
| `recallium version`         | Print the installed client version                                |

`login`, `enroll`, `logout`, and `unauthorize` are available in the Cloud client. Community does not require Cloud sign-in.

## Install options

| Option              | Effect                                                                  |
| ------------------- | ----------------------------------------------------------------------- |
| `--ide=<id,...>`    | Limit the operation to named coding agents                              |
| `--all`             | Include every supported agent, even if it was not detected              |
| `--dry-run`         | Preview changes without writing them                                    |
| `--yes`, `-y`       | Skip the interactive Install / Modify screen                            |
| `--skip-mcp`        | Install guidance and supported hooks without changing MCP registrations |
| `--no-enroll`       | Connect agents without Cloud sign-in; run `recallium login` later       |
| `--server <origin>` | Pin the MCP and sensor connection to an allowed server origin           |

Use `recallium help` to see the supported values for `--ide` in your installed version.

## Connect to Recallium Cloud

The standard installer connects supported coding agents to Recallium Cloud and opens the sign-in flow:

```bash theme={null}
recallium install
```

Use `recallium login` when you need to sign in again without changing agent configuration.

## Connect to Recallium Community

For a local Community server on the default port:

```bash theme={null}
recallium init --edition=community --port 8001
```

## Diagnose a connection

Run these commands in order:

```bash theme={null}
recallium status
recallium doctor
```

`status` explains what is connected. `doctor` reports failed checks and the command that can repair each supported issue.

If the Cloud credential is missing or expired, run:

```bash theme={null}
recallium login
```

If agent wiring is missing, rerun:

```bash theme={null}
recallium install
```

If the diagnostic report does not identify a repair, email [support@recallium.ai](mailto:support@recallium.ai) and include the output from `recallium status` and `recallium doctor`.

## Remove Recallium

In an interactive terminal, run `recallium uninstall` and deselect the agents you want to disconnect.

To remove everything managed by the client:

```bash theme={null}
recallium uninstall --all
```

This removes agent wiring and Recallium's local state. It prints the npm command you can run to remove the CLI package itself:

```bash theme={null}
npm uninstall -g recallium
```

The installer and uninstaller preserve configuration entries they do not own. Use `--dry-run` first if you want to review the affected files.