Skip to main content

​
OpenSRE CLI Setup

Set up or maintain opensre with minimal friction. If you are running this prompt, follow the steps below and set up OpenSRE for the user so they can ask about their infrastructure from the interactive shell. Do not clone the OpenSRE repo unless the user asked to contribute. The published CLI is enough.

​
Step 1: Install or upgrade the CLI

Check whether the CLI exists:
If opensre is missing, install it. On macOS or Linux:
On Windows, in PowerShell:
Windows details: Windows. No sudo on macOS/Linux in the usual case. If the installer cannot use a writable directory already on PATH, it puts the binary in ~/.local/bin and prints the command to add that directory. Apply that PATH update (or open a new terminal), then re-check command -v opensre. When opensre is already present, upgrade it:
Confirm it runs:

​
Step 2: Get started

First launch is interactive and needs a TTY. Do not try to fake the sign-in gate. Run opensre and prompt the user when it asks for input:
The browser opens the OpenSRE sign-up page. The user can create an account or sign in using email or another enabled provider. This activates the hosted model; do not ask the user for a separate LLM key during first run. When sign-in finishes, it opens the interactive shell. Add tools later with opensre integrations setup <service> when the agent should query them. To connect one tool later:
Replace <service> with a slug such as datadog, grafana, or slack. If sign-in cannot validate the webapp account, run opensre account status. The interactive shell intentionally stays closed while the session is expired, revoked, incomplete, or unreachable.

​
Step 3: Verify

One tool only:
If verify fails, check the printed error. Common causes: missing or expired credential, wrong URL, or a skipped setup step. Re-run opensre integrations setup <service> for that tool.

​
Step 4: Suggest a first run

They are already in the interactive shell after Step 2. Ask the user to describe an incident or ask a question in plain language, or use /help. To start it again later:

​
Gotchas

  • opensre: command not found — new terminal, or add the bin directory the installer printed (often ~/.local/bin on macOS/Linux).
  • Sign-in blocks or looks hung — it is waiting for webapp browser authentication. Show the user the URL and prompt; do not kill it.
  • The shell keeps returning to sign-in — run opensre account status; the account must be active before the shell or hosted model starts.
  • Only connected tools are queried — the agent cannot pull Datadog data if Datadog was never set up. Run opensre integrations verify before a production run.
Human docs: https://opensre.com/docs/install and https://opensre.com/docs/quickstart