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

# 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 theme={null}
        brew tap tracer-cloud/tap
        brew install tracer-cloud/tap/opensre
        ```

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

        <Frame>
          <img src="https://mintcdn.com/tracer/p9QMaHUNKBbW3kp5/images/quickstart-install.gif?s=4b9af812f3d7466553dd93b7a4935a07" alt="Installing OpenSRE with the one-line curl installer" width="790" height="560" data-path="images/quickstart-install.gif" />
        </Frame>
      </Tab>

      <Tab title="Windows">
        ```powershell theme={null}
        irm https://install.opensre.com | iex
        ```

        <Frame>
          <img src="https://mintcdn.com/tracer/p9QMaHUNKBbW3kp5/images/quickstart-install-windows.gif?s=0edb249f166bf30d1e959b08eedaed73" alt="Installing OpenSRE on Windows with the PowerShell installer" width="900" height="435" data-path="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 theme={null}
    opensre onboard
    ```

    <Tabs>
      <Tab title="macOS / Linux">
        <Frame>
          <img src="https://mintcdn.com/tracer/p9QMaHUNKBbW3kp5/images/quickstart-onboard.gif?s=dc220d562c4686ddc7117360f8165024" alt="Onboarding OpenSRE with the setup wizard to configure your LLM provider and integrations" width="790" height="560" data-path="images/quickstart-onboard.gif" />
        </Frame>
      </Tab>

      <Tab title="Windows">
        <Frame>
          <img src="https://mintcdn.com/tracer/p9QMaHUNKBbW3kp5/images/quickstart-onboard-windows.gif?s=3388b52a5a2710bbb2558246ca49db1d" alt="Onboarding OpenSRE on Windows with the setup wizard" width="900" height="487" data-path="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 theme={null}
    opensre
    ```

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

    ```bash theme={null}
    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>
          <img src="https://mintcdn.com/tracer/p9QMaHUNKBbW3kp5/images/quickstart-investigate.gif?s=879ef2fc978da1f592e1d938d7ac6b4a" alt="Running an OpenSRE investigation on a sample alert through to a structured root-cause report" width="790" height="560" data-path="images/quickstart-investigate.gif" />
        </Frame>
      </Tab>

      <Tab title="Windows">
        <Frame>
          <img src="https://mintcdn.com/tracer/p9QMaHUNKBbW3kp5/images/quickstart-investigate-windows.gif?s=08d60779ba729c9a90eedde36ed3d4a0" alt="Running an OpenSRE investigation on Windows through to a structured root-cause report" width="900" height="487" data-path="images/quickstart-investigate-windows.gif" />
        </Frame>
      </Tab>
    </Tabs>
  </Step>

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

## Uninstall

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

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

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

```bash theme={null}
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.