> ## 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.

# Quickstart

<Steps>
  <Step title="Install HealOps">
    <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>
  </Step>

  <Step title="Onboard">
    Run the onboarding wizard to configure your LLM provider and connect your integrations (Grafana, Datadog, Honeycomb, Coralogix, Slack, AWS, GitHub, Sentry):

    ```bash theme={null}
    healops onboard
    ```
  </Step>

  <Step title="Run an investigation">
    Choose either path — both use the same local `healops` CLI:

    **Interactive prompt shell** — start HealOps with no arguments (TTY) to type incidents in plain language and use slash commands (`/help`, `/status`, `/effort`, `/exit`, …):

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

    **Direct investigation** — one-shot run from your shell with an alert file:

    ```bash theme={null}
    healops investigate -i tests/e2e/kubernetes/fixtures/datadog_k8s_alert.json
    ```

    For file-based runs, HealOps fetches alert context, reasons across connected systems, and generates a structured root-cause report.
  </Step>

  <Step title="Keep up to date">
    ```bash theme={null}
    healops update
    ```
  </Step>
</Steps>

## Uninstall

To remove HealOps and all its local data from your machine:

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

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

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

## Troubleshooting

* **Docker is not running**: Start Docker Desktop, OrbStack, or Colima before running setup.
* **`make` is missing**: Install it via your package manager (`brew install make` on macOS, `choco install make` on Windows).
* **No local LLM provider is configured**: Run `healops onboard` to select and configure your LLM credentials.