docs: surface local LLM quickstart path#2665
Conversation
Greptile code reviewThis 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: 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 SummaryThis PR surfaces
Confidence Score: 4/5Safe 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
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
Reviews (1): Last reviewed commit: "docs: surface local LLM quickstart path" | Re-trigger Greptile |
| 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 | ||
| ``` |
There was a problem hiding this comment.
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.
| 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 |
| 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 | ||
| ``` |
There was a problem hiding this comment.
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.
| 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 | |
| ``` |
| uv sync --frozen --extra dev | ||
| uv run opensre --version | ||
| ``` | ||
|
|
||
| See [SETUP.md](SETUP.md) for the full source setup. |
There was a problem hiding this comment.
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.
| 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!
| 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. |
There was a problem hiding this comment.
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.
| 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!
|
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. |
Summary
opensre onboard local_llmas the no-API-key first-time evaluation pathuvsource-install fallback when the binary installer fails on older Linux hostsTest
python3docs smoke check for the new quickstart commandsCloses #1876