---
title: "Quickstart"
slug: "quickstart"
---

<Steps>
  <Step title="Install OpenSRE">
    <Tabs>
      <Tab title="macOS / Linux">
        Choose one install method. The one-line installer tracks the latest stable build from `main`.

        ```bash
        brew tap tracer-cloud/tap
        brew install tracer-cloud/tap/opensre
        ```

        ```bash
        curl -fsSL https://install.opensre.com | bash
        ```

        <Frame>
          ![Installing OpenSRE with the one-line curl installer](/images/quickstart-install.gif)
        </Frame>
      </Tab>
      <Tab title="Windows">
        ```powershell
        irm https://install.opensre.com | iex
        ```

        <Frame>
          ![Installing OpenSRE on Windows with the PowerShell installer](/images/quickstart-install-windows.gif)
        </Frame>
      </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 MCP, Sentry):

    ```bash
    opensre onboard
    ```

    <Tabs>
      <Tab title="macOS / Linux">
        <Frame>
          ![Onboarding OpenSRE with the setup wizard to configure your LLM provider and integrations](/images/quickstart-onboard.gif)
        </Frame>
      </Tab>
      <Tab title="Windows">
        <Frame>
          ![Onboarding OpenSRE on Windows with the setup wizard](/images/quickstart-onboard-windows.gif)
        </Frame>
      </Tab>
    </Tabs>

  </Step>

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

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

    ```bash
    opensre
    ```

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

    ```bash
    opensre investigate -i tests/e2e/kubernetes/fixtures/datadog_k8s_alert.json
    ```

    For file-based runs, OpenSRE fetches alert context, reasons across connected systems, and generates a structured root-cause report.

    <Tabs>
      <Tab title="macOS / Linux">
        <Frame>
          ![Running an OpenSRE investigation on a sample alert through to a structured root-cause report](/images/quickstart-investigate.gif)
        </Frame>
      </Tab>
      <Tab title="Windows">
        <Frame>
          ![Running an OpenSRE investigation on Windows through to a structured root-cause report](/images/quickstart-investigate-windows.gif)
        </Frame>
      </Tab>
    </Tabs>

  </Step>

  <Step title="Keep up to date">
    ```bash
    opensre update
    ```
  </Step>
</Steps>

## Uninstall

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

```bash
opensre uninstall
```

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

```bash
opensre 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 `opensre onboard` to select and configure your LLM credentials.
