Skip to main content

​
Before you begin

Make sure you have:
  • A terminal open in a code project
  • A Git repository (recommended for the full workflow demonstration)

​
Step 1: Install and start opensre

Then start OpenSRE:
OpenSRE CLI welcome screen with the sign-in prompt On Windows, open PowerShell and run:
See Windows. Prebuilt Linux binaries require glibc 2.35+ (Ubuntu 22.04+ or comparable). See platform requirements before installing on another distribution.

​
Step 2: Sign in

Choose Sign in or create account in the welcome screen. The browser opens the OpenSRE sign-up page, where you can use email or another enabled provider. Signing in activates the OpenSRE-hosted model, so you need no LLM key. Back in the terminal, OpenSRE confirms the session with the web app and opens the shell. If the sign-in screen comes back instead, see troubleshooting.

​
Step 3: Pick a demo, or skip it

The first shell prompt asks which demo to run:
The startup demo picker with its five options
Choose A to see what OpenSRE does with a real repository on your machine: it reads the last 30 days of GitHub Actions history and reports how reliable your CI is and how much developer time it costs. It needs GitHub access: connect it first with opensre integrations setup github (authorize in the browser, or paste a token). Without it the demo stops and names that command. See CI/CD analytics demo. Choose E to go straight to the prompt. Type /demo to open the menu again at any time, or start with opensre --skip-onboarding to skip it.

​
Step 4: Ask your first question

Choose either path — both use the same local opensre binary: Interactive shell — start OpenSRE with no arguments and describe what’s going on in plain English:
One-shot headless run — a single agent turn from your shell or a CI job:
OpenSRE reasons across your connected systems, calling the tools it needs, and prints the answer. See Headless CLI for tool approvals, --json output, and exit codes. Inside the interactive shell, /help lists commands, /status shows the current setup, /effort changes reasoning effort, and /exit closes the shell.
Running an OpenSRE turn on a sample incident
Connect the tools OpenSRE should read with opensre integrations setup <service> or /integrations setup <service> in the shell. Good first tasks, once GitHub is connected:
More in CI/CD with OpenSRE.

​
Step 5: Keep up to date

​
Uninstall

To remove opensre and all its local data from your machine:
Pass --yes to skip the confirmation prompt:

​
Troubleshooting

  • opensre is not found: Open a new terminal, or add the bin directory printed by the installer to PATH.
  • The Linux binary does not start: Prebuilt binaries require glibc 2.35 or newer; use a supported distribution or the Docker guide.
  • make is missing: See the development setup guide if you are working from source.
  • The demo menu did not appear: Menus need an interactive terminal. Run opensre in a terminal window rather than through a pipe or a CI job, then type /demo.
  • The sign-in screen comes back after you signed in: Run opensre account status; it names what is wrong with the session (expired, revoked, or the web app unreachable).