> ## 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.

# Quickstart

## 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

```bash theme={null}
curl -fsSL https://install.opensre.com | bash -s -- -dc
```

Then start OpenSRE:

```bash theme={null}
opensre
```

![OpenSRE CLI welcome screen with the sign-in prompt](https://mintcdn.com/tracer/N6OGfOUQjx4VJof5/images/opensre-welcome.png?fit=max\&auto=format\&n=N6OGfOUQjx4VJof5\&q=85\&s=a111e922dc38f18a550747d6974f2521)

On Windows, open PowerShell and run:

```powershell theme={null}
& ([scriptblock]::Create((irm https://install.opensre.com/install.ps1))) -dc
```

See [Windows](https://opensre.com/docs/install/windows-local.md).

Prebuilt Linux binaries require **glibc 2.35+** (Ubuntu 22.04+ or comparable). See [platform requirements](https://opensre.com/docs/install/linux-local.md#binary-compatibility) 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](#troubleshooting).

## Step 3: Pick what to do

The first shell prompt asks what you want to do:

```text theme={null}
What would you like to do?
  (A) Analyze & improve a repo (recommended)
  (B) Keep my CI/CD healthy automatically
  (C) Open the shell
```

Choosing **B** asks how that should run:

```text theme={null}
Keep my CI/CD healthy automatically
  (A) Run continuously on this machine (recommended)
  (B) Run one repair in OpenSRE Cloud
  (C) Connect Slack
```

Choose **A** to see what OpenSRE does with a 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
in the OpenSRE app through OAuth or its token-entry form. Run
`opensre account login` to load that connection on this machine. If it is
missing, the flow offers the app setup link. See
[CI/CD analytics demo](https://opensre.com/docs/cicd/cicd-analytics-demo.md).

Choose **C** 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:

```bash theme={null}
opensre
```

**One-shot headless run** — a single agent turn from your shell or a CI job:

```bash theme={null}
opensre ask "why did checkout latency increase today?"
```

OpenSRE reasons across your connected systems, calling the tools it needs, and prints the answer. See [Headless CLI](https://opensre.com/docs/guides/headless-cli.md) 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](https://mintcdn.com/tracer/p9QMaHUNKBbW3kp5/images/quickstart-investigate.gif?s=879ef2fc978da1f592e1d938d7ac6b4a)

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:

```text theme={null}
analyze Tracer-Cloud/opensre CI/CD performance for the last 30 days
how many PRs and branches currently have failing CI across all my orgs?
fix failing checks on Tracer-Cloud/opensre#4597
```

More in [CI/CD with OpenSRE](https://opensre.com/docs/cicd/overview.md).

## Step 5: Keep up to date

```bash theme={null}
opensre update
```

## Uninstall

To remove opensre and all its local data from your machine:

```bash theme={null}
opensre uninstall
```

Pass `--yes` to skip the confirmation prompt:

```bash theme={null}
opensre uninstall --yes
```

## 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](https://opensre.com/docs/install/docker.md).
* **`make` is missing**: See the [development setup guide](https://github.com/Tracer-Cloud/opensre/blob/main/SETUP.md) 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).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.