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

# CLI reference

> Run Magnitude, manage models, and install updates from your terminal.

The Magnitude installation includes the `magnitude` CLI. In a new terminal, run:

```sh theme={"theme":{"light":"github-light","dark":"github-dark"}}
magnitude --help
```

Running `magnitude` without a subcommand prints help. No npm installation is required.

## Run Magnitude

| Command | Purpose |
| - | - |
| `magnitude app open` | Show the desktop window. |
| `magnitude serve` | Run the service in the foreground without opening Desktop. |
| `magnitude status` | Check whether Magnitude is running and inspect service and model status. |

Model, catalog, hardware, and connection setup commands require a running Desktop or `magnitude serve`.
Stop a foreground server with Ctrl+C. Opening Desktop takes over from a foreground server.
Only one Desktop or `serve` instance can run under the same user account. Fully quit Desktop or stop the existing `serve` command before starting another server. See [Remote server](/remote-server) for setup.

Use **Launch at login** in Desktop Settings for login startup, and **Quit Magnitude** to stop Desktop.

## Find and download models

Assessment and downloads run in the background. Use status commands to check progress.

| Command | Purpose |
| - | - |
| `hardware` | Inspect detected hardware and memory. |
| `catalog status` | Check catalog preparation and assessment. |
| `catalog list` | List compatible catalog models. |
| `catalog show <model-id>` | Read model details. |
| `catalog recommendations` | Rank recommendations; defaults to Balanced and a limit of 10. |
| `catalog pull <model-id>` | Download or update a catalog model. |
| `catalog cancel <model-id>` | Cancel a download or model update. |
| `catalog remove <model-id>` | Remove an installed model. |
| `models status [model-id]` | Inspect downloaded models and loading state. |
| `models load <model-id>` | Load a downloaded model into memory. |
| `models stop` | Stop the active model without deleting it. |

Prefix each command with `magnitude`. Recommendation preferences are `fastest`, `faster`, `balanced`, `smarter`, and `smartest`; use `--preference` and `--limit` to choose.

## Connections

| Command | Purpose |
| - | - |
| `magnitude connections list` | Inspect installed agents and connection state. |
| `magnitude connections connect <harness>` | Configure an agent on this computer, for you. |
| `magnitude connections sync [harness]` | Refresh one or all configured integrations. |
| `magnitude connections remove <harness>` | Disconnect an agent. |

`connections connect` accepts `--set-model <model-id>` to select a model and `--install-skill` to install or refresh its Magnitude skill. Skill installation is automatic for Pi.

Harness IDs: `pi`, `opencode`, `hermes`, `openclaw`, `codex`, `claude-code`, `oh-my-pi`, and `cline`. See [Integrations](/integrations/overview) for agent-specific instructions.

## Updates

| Command | Purpose |
| - | - |
| `magnitude update` or `magnitude update check` | Check for a newer Magnitude release. |
| `magnitude update status` | Read update state without starting the app. |
| `magnitude update download` | Download the available update and wait until it is ready to install. |
| `magnitude update install` | Install a prepared update; stop inference and restart Desktop if it was running. |
| `magnitude update discard` | Remove a retained update download. |

These commands update Desktop, the server, and CLI together. Checking, downloading, inspecting, or discarding an update does not open Desktop.

`update install` refuses to interrupt a running `serve` command. Stop the server first. Installation leaves a stopped server stopped; run `magnitude serve` afterward. A prepared update is also installed at the next startup unless an earlier installation attempt failed. Failed attempts require an explicit `update install` retry. Linux installation may require administrator authorization.

## Help

Use `--help` after any command to see its options. `magnitude --version` prints the installed CLI version. `magnitude docs` lists documentation bundled with the CLI, and `magnitude docs cli` prints its command guide.

## Configuration

Settings are stored in `~/.magnitude/config.json`. See [Configuration file](/reference/configuration-file).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.