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 Use a macOS or Linux terminal. On Windows, use WSL. 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. A successful login activates the OpenSRE-hosted model. OpenSRE then validates the new session and opens the interactive shell. Add integrations later with opensre integrations setup <service> when you want OpenSRE to query a specific tool.

​
Step 3: Ask your first question

Choose either path — both use the same local opensre binary: Interactive prompt shell — start OpenSRE with no arguments (TTY). The shell opens only after the webapp validates your account; choosing Exit and stay signed out leaves account-independent CLI commands available:
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

​
Step 4: Keep up to date

​
Uninstall

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

​
Troubleshooting

  • Docker is not running: Start Docker Desktop, OrbStack, or Colima before running opensre.
  • make is missing: See the development setup guide if you are working from source.
  • The shell does not open after login: Run opensre account status. The webapp must be reachable and the stored account token and metadata must both be valid.
  • You want to stay signed out: Choose Exit and stay signed out at startup. Commands such as opensre account, opensre doctor, and opensre integrations remain available, but the interactive shell stays closed.