Local and on-prem setup

Run OpenSRE on your laptop, a VM, or an on-prem host with the local CLI.

Use this guide when you’re installing the opensre binary yourself — on a laptop, a shared VM, or a machine in your own network.

Which setup fits you?

Setup	Best for
Laptop	Trying OpenSRE, local debugging, personal use
On-prem VM / server	A shared box your team can reach
Docker	Same install every time, in a container

Platform steps:

• macOS
• Linux (local)
• Windows (local)
• Docker

1. Install the CLI

# Homebrew
brew tap tracer-cloud/tap
brew install tracer-cloud/tap/opensre

# or one-line installer
curl -fsSL https://install.opensre.com | bash

On Windows (PowerShell):

irm https://install.opensre.com | iex

You usually don’t need sudo. The installer puts opensre somewhere already on your PATH when it can. If it can’t, it uses ~/.local/bin and prints how to add that to PATH.

Auto onboard: In a normal interactive terminal, install often starts opensre onboard when it finishes. In CI or scripts it skips that. To turn auto-onboard off:

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

GitHub CLI: The installer also tries to install gh if it’s missing (OpenSRE’s GitHub tools need it). Skip that with:

curl -fsSL https://install.opensre.com | OPENSRE_SKIP_GH_INSTALL=1 bash

Homebrew installs pull in gh automatically.

Shorter overview: Install OpenSRE.

2. Open the shell

opensre

That starts the interactive prompt. You can also run commands as opensre … from a normal terminal without entering the shell.

3. Run onboarding

Inside the shell:

onboard

Or from a normal terminal:

opensre onboard

You’ll set up:

• Your LLM (so OpenSRE can reason about incidents)
• Tool credentials (Datadog, Grafana, Slack, and so on)
• Optional messaging and reporting

Where credentials are saved

OpenSRE checks environment variables first. When onboarding saves a credential, it writes to an owner-only file at ~/.opensre/credentials.json (mode 0600). That keeps first-run setup from writing credentials to disk.

You can also provide a credential through your shell or project .env; environment values take precedence. Never commit real credentials to .env or source control.

To keep credentials only in the environment (nothing written to disk), set OPENSRE_DISABLE_KEYRING=1.

4. Check your tools

Inside the shell:

integrations verify

One tool only:

integrations verify datadog

From a normal terminal, prefix with opensre (for example opensre integrations verify).

5. Run a first investigation

Inside the shell:

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

From your normal terminal:

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

Where to connect tools

The full tool list lives under Integrations, not Install.

Start at Integrations overview, then open each provider page for keys, permissions, and examples.

Related

• Quickstart — install + onboard + sample run with GIFs
• Investigations overview — how investigations work end to end
• Deployment — gateway and hosted options beyond a single laptop