wehub-resource-sync
4b6817381b
CI (OpenClaw E2E) / openclaw test (push) Has been cancelled
CI / coverage-report (push) Has been cancelled
CI / test-kubernetes (push) Has been cancelled
CI / should-run-thorough (push) Has been cancelled
CI / test-thorough (cloudwatch-demo) (push) Has been cancelled
CI / test-thorough (flink-ecs) (push) Has been cancelled
CI / test-thorough (upstream-lambda) (push) Has been cancelled
CI / test-thorough (prefect-ecs-fargate) (push) Has been cancelled
Release / build-binaries (zip, opensre.exe, onefile, windows-latest, windows-x64) (push) Has been cancelled
Benchmark image — build + push to ECR (any adapter) / build + push (push) Has been cancelled
CI / quality (ubuntu-latest) (push) Has been cancelled
CI / test (tools-runtime) (push) Has been cancelled
CI / test (e2e-general) (push) Has been cancelled
CI / test (cli-runtime) (push) Has been cancelled
CI / test (e2e-provider-and-openclaw) (push) Has been cancelled
CI / test (integrations-and-misc) (push) Has been cancelled
Release / verify (push) Has been cancelled
Release / build-python-dist (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-15-intel, darwin-x64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, macos-latest, darwin-arm64) (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04, linux-x64) (push) Has been cancelled
Release / publish-release (push) Has been cancelled
Release / publish-main-release (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-checks (no-LLM) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Interactive Shell Live (PR + post-merge) / turn-live shard ${{ matrix.shard_index }} (push) Has been cancelled
Release / prepare (push) Has been cancelled
Release / build-binaries (tar.gz, opensre, onedir, ubuntu-22.04-arm, linux-arm64) (push) Has been cancelled
Synthetic Deterministic Tests / Synthetic offline (deterministic) (push) Has been cancelled
118 lines
3.2 KiB
Plaintext
118 lines
3.2 KiB
Plaintext
---
|
|
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>
|
|
|
|
</Frame>
|
|
</Tab>
|
|
<Tab title="Windows">
|
|
```powershell
|
|
irm https://install.opensre.com | iex
|
|
```
|
|
|
|
<Frame>
|
|
|
|
</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>
|
|
|
|
</Frame>
|
|
</Tab>
|
|
<Tab title="Windows">
|
|
<Frame>
|
|
|
|
</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>
|
|
|
|
</Frame>
|
|
</Tab>
|
|
<Tab title="Windows">
|
|
<Frame>
|
|
|
|
</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.
|