From 5b9362918ee6fce26da33eacffdff36aa79b4a9e Mon Sep 17 00:00:00 2001 From: Advait Paliwal Date: Thu, 9 Apr 2026 13:45:19 -0700 Subject: [PATCH] document local model setup --- README.md | 2 ++ .../src/content/docs/getting-started/setup.md | 27 +++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/README.md b/README.md index 017a847..bf3f102 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ The one-line installer fetches the latest tagged release. To pin a version, pass If you install via `pnpm` or `bun` instead of the standalone bundle, Feynman requires Node.js `20.19.0` or newer. +Local models are supported through the custom-provider flow. For Ollama, run `feynman setup`, choose `Custom provider (baseUrl + API key)`, use `openai-completions`, and point it at `http://localhost:11434/v1`. + ### Skills Only If you want just the research skills without the full terminal app: diff --git a/website/src/content/docs/getting-started/setup.md b/website/src/content/docs/getting-started/setup.md index 7bd431e..608449b 100644 --- a/website/src/content/docs/getting-started/setup.md +++ b/website/src/content/docs/getting-started/setup.md @@ -42,6 +42,33 @@ For API key providers, you are prompted to paste your key directly: Keys are encrypted at rest and never sent anywhere except the provider's API endpoint. +### Local models: Ollama, LM Studio, vLLM + +If you want to use a model running locally, choose the API-key flow and then select: + +```text +Custom provider (baseUrl + API key) +``` + +For Ollama, the typical settings are: + +```text +API mode: openai-completions +Base URL: http://localhost:11434/v1 +Authorization header: No +Model ids: llama3.1:8b +API key: local +``` + +That same custom-provider flow also works for other OpenAI-compatible local servers such as LM Studio or vLLM. After saving the provider, run: + +```bash +feynman model list +feynman model set / +``` + +to confirm the local model is available and make it the default. + ## Stage 3: Optional packages Feynman's core ships with the essentials, but some features require additional packages. The wizard asks if you want to install optional presets: