Skip to main content

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.

1

Install OpenSRE

Choose one install method:
brew tap tracer-cloud/tap
brew install tracer-cloud/tap/opensre
curl -fsSL https://install.opensre.com | bash
2

Onboard

Run the onboarding wizard to configure your LLM provider and connect your integrations (Grafana, Datadog, Honeycomb, Coralogix, Slack, AWS, GitHub MCP, Sentry):
opensre onboard
3

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, /exit):
opensre
Direct investigation — one-shot run from your shell with an alert file:
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.
4

Keep up to date

opensre update

Uninstall

To remove opensre and all its local data from your machine:
opensre uninstall
Pass --yes to skip the confirmation prompt:
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.