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

# CLI Integration Setup

> Install the HealOps CLI, connect your integrations, and run your first investigation

The HealOps CLI is the primary way to connect your tooling, run incident investigations, and verify integration health on your local machine or on-prem host.

## Install the HealOps CLI

<Tabs>
  <Tab title="macOS / Linux">
    **Homebrew (recommended):**

    ```bash theme={null}
    brew tap healops-ai/tap
    brew install healops-ai/tap/healops
    ```

    **curl installer:**

    ```bash theme={null}
    curl -fsSL https://install.healops.ai | bash
    ```

    **pip (Python 3.12+):**

    ```bash theme={null}
    pip install healops-cli
    ```
  </Tab>

  <Tab title="Windows">
    **PowerShell installer:**

    ```powershell theme={null}
    irm https://install.healops.ai | iex
    ```

    **pip (Python 3.12+):**

    ```powershell theme={null}
    pip install healops-cli
    ```
  </Tab>
</Tabs>

Verify the install:

```bash theme={null}
healops --version
```

***

## Run the onboarding wizard

`healops onboard` walks you through every configuration step in one session — LLM credentials, observability integrations, and communication channels.

```bash theme={null}
healops onboard
```

The wizard configures:

| Step           | What it sets up                                          |
| -------------- | -------------------------------------------------------- |
| LLM provider   | Anthropic, OpenAI, or a compatible local model           |
| Observability  | Datadog, Grafana, Honeycomb, Coralogix, Sentry, and more |
| Infrastructure | Kubernetes, AWS, Azure                                   |
| Communication  | Slack, Discord, or Telegram for investigation reports    |

You can re-run `healops onboard` at any time to add or update credentials.

***

## Configure integrations manually

### Set up all integrations interactively

From the HealOps interactive shell:

```bash theme={null}
healops
```

Then inside the shell:

```bash theme={null}
integrations setup
```

### Set up a specific integration

```bash theme={null}
healops integrations setup datadog
healops integrations setup kubernetes
healops integrations setup slack
```

### Configure via environment variables

HealOps picks up credentials from environment variables automatically. Set the relevant variables before starting the CLI:

```bash theme={null}
export DD_API_KEY="your-datadog-api-key"
export DD_APP_KEY="your-datadog-app-key"
export ANTHROPIC_API_KEY="your-anthropic-api-key"
healops
```

See the [Integrations overview](/integrations-overview) for the full list of environment variable names for each integration.

***

## Integration categories

| Category                      | Integrations                                                                                                    |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------- |
| **Observability & incidents** | Datadog, Grafana, Honeycomb, Coralogix, Sentry, BetterStack, AlertManager, Azure Monitor, OpsGenie, incident.io |
| **Infrastructure**            | Kubernetes, AWS, Helm                                                                                           |
| **Databases**                 | MongoDB, PostgreSQL, MySQL, MariaDB, ClickHouse, RDS                                                            |
| **Source control & CI**       | GitHub, GitLab, Bitbucket                                                                                       |
| **Messaging**                 | Slack, Discord, Telegram                                                                                        |
| **Deployments**               | Vercel, ArgoCD                                                                                                  |
| **Orchestration**             | Airflow, Prefect                                                                                                |
| **Messaging queues**          | Kafka, RabbitMQ                                                                                                 |
| **Incident management**       | Jira                                                                                                            |
| **Reporting**                 | Google Docs                                                                                                     |

***

## Verify integration health

After setup, confirm each integration is reachable:

```bash theme={null}
healops integrations verify
```

To check one integration:

```bash theme={null}
healops integrations verify datadog
healops integrations verify kubernetes
```

A passing output confirms HealOps can authenticate and read from that system. If a check fails, the output includes the specific error and a remediation hint.

***

## Run your first investigation

**Interactive shell** — start HealOps with no arguments to enter the prompt shell. Type incidents in plain language or use slash commands:

```bash theme={null}
healops
```

Useful shell commands:

| Command    | Description                               |
| ---------- | ----------------------------------------- |
| `/help`    | List all available slash commands         |
| `/status`  | Show current investigation status         |
| `/effort`  | Show investigation effort and steps taken |
| `/watches` | List active alert watches                 |
| `/exit`    | Exit the shell                            |

**One-shot investigation** — pass an alert file directly without entering the shell:

```bash theme={null}
healops investigate -i path/to/alert.json
```

HealOps fetches context from your connected systems, builds root cause hypotheses, and outputs a structured report. If Slack is configured, the report is also delivered to your configured channel.

***

## Keep the CLI up to date

```bash theme={null}
healops update
```

***

## Uninstall

To remove HealOps and all locally stored configuration:

```bash theme={null}
healops uninstall
```

Pass `--yes` to skip the confirmation prompt:

```bash theme={null}
healops uninstall --yes
```

***

## Troubleshooting

**`healops: command not found`**
Run `source ~/.bashrc` (or `~/.zshrc` on macOS) after install, then retry.

**Docker is not running**
Start Docker Desktop, OrbStack, or Colima. HealOps uses containers for some integration health checks.

**`make` is missing**
Install via your package manager: `brew install make` on macOS or `choco install make` on Windows.

**No LLM provider configured**
Run `healops onboard` and follow the LLM setup step. You need a valid API key from Anthropic, OpenAI, or a compatible provider.

**Integration verification fails**
Re-run `healops integrations setup <integration>` to refresh credentials. Check the provider-specific page under [Integrations](/integrations-overview) for required API scopes.

***

## Related guides

* [Quickstart](/quickstart)
* [Integrations overview](/integrations-overview)
* [Investigations overview](/investigation-overview)
* [Local and on-prem setup](/install-local)