Skip to content

docs: surface local LLM quickstart path#2665

Closed
nikhil8182 wants to merge 1 commit into
Tracer-Cloud:mainfrom
nikhil8182:docs/quickstart-local-llm-fallback
Closed

docs: surface local LLM quickstart path#2665
nikhil8182 wants to merge 1 commit into
Tracer-Cloud:mainfrom
nikhil8182:docs/quickstart-local-llm-fallback

Conversation

@nikhil8182
Copy link
Copy Markdown

Summary

  • surface opensre onboard local_llm as the no-API-key first-time evaluation path
  • document a uv source-install fallback when the binary installer fails on older Linux hosts
  • mirror the same quickstart guidance in README and docs

Test

  • python3 docs smoke check for the new quickstart commands

Closes #1876

@github-actions
Copy link
Copy Markdown
Contributor

Greptile code review

This repo uses Greptile for automated review. Before merge, aim for Confidence Score: 5/5 with zero unresolved review threads — see CONTRIBUTING.md.

Run a review — add a PR comment with:

@greptile review

Give it ~5-10 minutes (sometimes longer) for results, then fix feedback and re-trigger until you reach Confidence Score: 5/5.

Optional: automate with the greploop skill.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 30, 2026

Greptile Summary

This PR surfaces opensre onboard local_llm as the recommended no-API-key evaluation path and adds a uv source-install fallback for older Linux hosts that can't use the binary installer. Both changes are mirrored between README.md and docs/quickstart.mdx.

  • The opensre onboard local_llm command is verified to exist in the CLI (app/cli/commands/onboard.py, app/cli/local_llm/command.py) and the tabbed MDX structure looks correct.
  • The uv fallback snippet omits the prerequisite uv installation step — on the older Linux hosts this path targets, uv is unlikely to be present, which would cause the very first command to fail with command not found.
  • Both files pass --extra dev to uv sync, which installs pytest, pre-commit, and other test tooling that end users evaluating the product don't need; dropping the flag still satisfies runtime dependencies.

Confidence Score: 4/5

Safe to merge after addressing the missing uv prerequisite step; the broken fallback path is the only issue that would cause a user to fail following the docs.

The opensre onboard local_llm command exists and is wired up correctly. The main concern is that the uv source-install fallback skips the uv installation step — users on older Linux hosts who hit this path would immediately get a command not found error. The --extra dev flag is a separate, lower-stakes issue that just inflates the install with test tooling.

Both README.md and docs/quickstart.mdx carry the same missing prerequisite; fixing one should be mirrored to the other.

Important Files Changed

Filename Overview
README.md Adds uv source-install fallback and local_llm onboard path; missing uv prerequisite install step and --extra dev pulls in unneeded test dependencies
docs/quickstart.mdx Mirrors README changes in MDX format with tabbed onboard UI; same missing uv prerequisite and unnecessary --extra dev flag as README

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User wants to try OpenSRE] --> B{Binary install}
    B -->|macOS / Linux| C[brew / curl installer]
    B -->|Windows| D[irm PowerShell installer]
    B -->|Fails on older Linux| E[uv source fallback]
    E --> E1[Install uv]
    E1 --> E2[git clone + uv sync --frozen]
    E2 --> E3[uv run opensre --version]
    C --> F{Choose onboard path}
    D --> F
    E3 --> F
    F -->|No API key| G[opensre onboard local_llm Ollama / local model]
    F -->|Hosted provider| H[opensre onboard Anthropic / OpenAI / Bedrock]
    G --> I[opensre investigate]
    H --> I
Loading

Reviews (1): Last reviewed commit: "docs: surface local LLM quickstart path" | Re-trigger Greptile

Comment thread README.md
Comment on lines +117 to +124
If the binary install fails on an older Linux host, run from source with `uv`:

```bash
git clone https://github.com/Tracer-Cloud/opensre.git
cd opensre
uv sync --frozen --extra dev
uv run opensre --version
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 The fallback path jumps straight to uv sync without first ensuring uv is available. On the older Linux hosts this snippet targets, uv almost certainly isn't installed — running uv sync will fail with command not found. SETUP.md already documents the install one-liner; it should be echoed here so the fallback is fully self-contained.

Suggested change
If the binary install fails on an older Linux host, run from source with `uv`:
```bash
git clone https://github.com/Tracer-Cloud/opensre.git
cd opensre
uv sync --frozen --extra dev
uv run opensre --version
```
If the binary install fails on an older Linux host, install `uv` first, then run from source:
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
git clone https://github.com/Tracer-Cloud/opensre.git
cd opensre
uv sync --frozen --extra dev
uv run opensre --version

Comment thread docs/quickstart.mdx
Comment on lines +28 to +35
If the binary install fails on an older Linux host, run from source with `uv`:

```bash
git clone https://github.com/Tracer-Cloud/opensre.git
cd opensre
uv sync --frozen --extra dev
uv run opensre --version
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Same missing uv prerequisite as in README — the fallback is aimed at users whose binary install already failed, so they are unlikely to have uv in their PATH already. Adding the install one-liner makes the path fully self-contained.

Suggested change
If the binary install fails on an older Linux host, run from source with `uv`:
```bash
git clone https://github.com/Tracer-Cloud/opensre.git
cd opensre
uv sync --frozen --extra dev
uv run opensre --version
```
If the binary install fails on an older Linux host, install `uv` first, then run from source:
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
git clone https://github.com/Tracer-Cloud/opensre.git
cd opensre
uv sync --frozen --extra dev
uv run opensre --version
```

Comment thread README.md
Comment on lines +122 to +126
uv sync --frozen --extra dev
uv run opensre --version
```

See [SETUP.md](SETUP.md) for the full source setup.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The --extra dev flag installs the [project.optional-dependencies] dev group, which includes pytest, pytest-asyncio, pytest-cov, and pre-commit — none of which are needed to run opensre as an end-user evaluating the product. Dropping this flag still installs the default [dependency-groups] dev group (uv's PEP 735 behaviour) and keeps the environment lean for a first-time evaluation scenario.

Suggested change
uv sync --frozen --extra dev
uv run opensre --version
```
See [SETUP.md](SETUP.md) for the full source setup.
uv sync --frozen
uv run opensre --version

See SETUP.md for the full source setup.


Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment thread docs/quickstart.mdx
Comment on lines +33 to +37
uv sync --frozen --extra dev
uv run opensre --version
```

See [SETUP.md](https://github.com/Tracer-Cloud/opensre/blob/main/SETUP.md) for the full source setup.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Same concern as in the README: --extra dev pulls in pytest, pre-commit, and other testing tools that users evaluating the product via opensre onboard local_llm don't need. uv sync --frozen is sufficient to run opensre.

Suggested change
uv sync --frozen --extra dev
uv run opensre --version
```
See [SETUP.md](https://github.com/Tracer-Cloud/opensre/blob/main/SETUP.md) for the full source setup.
uv sync --frozen
uv run opensre --version
```
See [SETUP.md](https://github.com/Tracer-Cloud/opensre/blob/main/SETUP.md) for the full source setup.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@cerencamkiran
Copy link
Copy Markdown
Collaborator

Closing for now. Please wait for assignment, avoid opening multiple prs at the same time, and spend a little more time exploring the project before opening new prs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[IMPROVEMENT] OpenSRE quickstart UX: surface local_llm path, document source-install fallback, unify provider-error UX

2 participants