Skip to content

docs: add Ollama Setup instructions and example .env#3154

Open
dane11stanisic-a11y wants to merge 1 commit into
thedotmack:mainfrom
dane11stanisic-a11y:docs/ollama-setup
Open

docs: add Ollama Setup instructions and example .env#3154
dane11stanisic-a11y wants to merge 1 commit into
thedotmack:mainfrom
dane11stanisic-a11y:docs/ollama-setup

Conversation

@dane11stanisic-a11y

Copy link
Copy Markdown

Adds a new Ollama Setup section to configuration docs, including example ~/.claude-mem/.env values and test commands for local Ollama usage.

@greptile-apps

greptile-apps Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds Ollama setup guidance to the configuration docs. The main changes are:

  • New OLLAMA_BASE_URL, OLLAMA_API_KEY, and OLLAMA_MODEL environment variable entries.
  • Example ~/.claude-mem/.env values for local Ollama usage.
  • Quick-check instructions for verifying the Ollama service and selected model.

Confidence Score: 4/5

This documentation change needs one correction before the setup path is reliable.

A documented command points to a helper script that is not included, so the new quick-check instructions fail for users. The rest of the change is limited to documentation.

docs/public/configuration.mdx

T-Rex T-Rex Logs

What T-Rex did

  • I reproduced the missing helper script verification by running the generated Python harness, which reads docs/public/configuration.mdx and confirmed that the documented C:\\Claude\\scripts\\test_ollama.ps1 helper is unavailable, exiting with code 1.
  • I completed the contract-validation step by running the MDX parse and the Ollama model-check stub; both steps reported success (MDX parse ok and MODEL_CHECK_OK), and I saved a combined command-output summary for review.

View all artifacts

T-Rex Ran code and verified through T-Rex

Important Files Changed

Filename Overview
docs/public/configuration.mdx Adds Ollama environment-variable documentation and setup steps, but references a PowerShell helper script that is not present in the repository.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
participant User
participant Env as ~/.claude-mem/.env
participant Worker as claude-mem worker
participant Ollama as Ollama endpoint
User->>Env: Configure OLLAMA_BASE_URL / OLLAMA_API_KEY / OLLAMA_MODEL
Worker->>Env: Read gateway credentials at startup
Worker->>Ollama: Send model request using configured endpoint
Ollama-->>Worker: Return model response
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
participant User
participant Env as ~/.claude-mem/.env
participant Worker as claude-mem worker
participant Ollama as Ollama endpoint
User->>Env: Configure OLLAMA_BASE_URL / OLLAMA_API_KEY / OLLAMA_MODEL
Worker->>Env: Read gateway credentials at startup
Worker->>Ollama: Send model request using configured endpoint
Ollama-->>Worker: Return model response
Loading

Reviews (1): Last reviewed commit: "docs: add Ollama Setup instructions and ..." | Re-trigger Greptile

Comment on lines +76 to +80
- Use the provided helper to print a curl example and run a quick request:

```powershell
Set-Location -Path 'C:\Claude\claude-mem'
& 'C:\Claude\scripts\test_ollama.ps1'

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 Missing helper script
The docs tell users to run a “provided helper” at C:\Claude\scripts\test_ollama.ps1, but this PR does not add that script and no test_ollama.ps1 exists in the repository. Following this setup path fails before any Ollama request is tested, so either add the helper or replace this with commands that are actually available.

Artifacts

Repro: generated missing helper verification harness

  • Contains supporting evidence from the run (text/x-python; charset=utf-8).

Repro: failing helper availability check output

  • Keeps the command output available without making the summary code-heavy.

View artifacts

T-Rex Ran code and verified through T-Rex

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.

1 participant