---
title: "Local and on-prem setup"
description: "Run OpenSRE locally with the CLI binary and onboard integrations from your environment"
---

This guide is for teams running OpenSRE with the local `opensre` binary on developer machines, virtual machines, or on-prem
hosts.

## What mode should I use?

Use the mode that matches where your workloads and alerts live:

- **Local laptop mode** for fast setup, testing, and debugging
- **On-prem VM/server mode** for shared internal environments
- **Container mode** for reproducible deployments in Docker

Environment-specific install steps live under the `Installation` tab:

- [macOS](/environments/macos)
- [Linux (local)](/environments/linux-local)
- [Windows (local)](/environments/windows-local)
- [Docker](/environments/docker)

## Local setup workflow

### 1) Install the OpenSRE CLI

```bash
brew tap tracer-cloud/tap
brew install tracer-cloud/tap/opensre
# or
curl -fsSL https://install.opensre.com | bash
```

The macOS/Linux installer does not require `sudo`. It uses a writable bin directory already on your `PATH` when possible; otherwise it installs to `~/.local/bin` and prints the command to apply the PATH update in your shell.

The installer makes `opensre` available on your PATH without sudo: it installs into (or links the binary from) a user-writable directory that is already on your PATH, so the command works in the current terminal right away. Only when no such directory exists does it fall back to updating your shell profile for new terminals.

When you run the installer from an interactive terminal — including the piped `curl … | bash` form above — it launches `opensre onboard` automatically once the install finishes, so you can set up your LLM provider and integrations right away. In non-interactive environments (CI, scripts, provisioning) the auto-launch is skipped and a "Next steps" hint is printed instead. To opt out of the auto-launch entirely:

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

### 2) Enter the OpenSRE shell

```bash
opensre
```

### 3) Run onboarding

From inside the OpenSRE shell:

```bash
onboard
```

`onboard` helps you configure:

- LLM provider (for investigation reasoning)
- integration credentials
- optional communication/reporting integrations

### 4) Verify integration health

From inside the OpenSRE shell:

```bash
integrations verify
```

To verify one integration:

```bash
integrations verify <integration-name>
```

### 5) Run your first investigation

**From inside the OpenSRE shell** (after running bare `opensre`):

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

**From your normal terminal** (direct investigation, no shell):

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

## Integration catalog

The full integration catalog is maintained under the `Integrations` tab, not the `Installation` tab.

Start here:

- [Integrations overview](/integrations-overview)

Then open each provider page for credentials, minimum permissions, and setup examples.

## Related guides

- [Quickstart](/quickstart)
- [Investigations overview](/investigation-overview)
