From ec87cde370dfaa82c68ec402177407ae8c2aa756 Mon Sep 17 00:00:00 2001 From: Eric Curtin Date: Fri, 4 Sep 2026 15:48:26 +0100 Subject: [PATCH] docs: add llmman as a local OpenAI-compatible provider example llmman (https://github.com/llmmanorg/llmman) serves the Ollama and OpenAI-compatible APIs on port 17434 and already works via the generic `custom` provider, but nothing tells users which endpoint to use. Mention it next to Ollama in the README, the BYOM onboarding hint and the `ProviderConfig::Custom` doc comment. No code paths change. --- README.md | 9 ++++++++- cli/src/onboarding/byom.rs | 6 ++++-- libs/shared/src/models/llm.rs | 2 +- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3b8af045c..dfbec2d1a 100644 --- a/README.md +++ b/README.md @@ -277,7 +277,7 @@ api_key = "..." [settings] ``` -**Option 2: Bring Your Own LLM** - Use a local OpenAI-compatible endpoint (e.g. Ollama, LM Studio): +**Option 2: Bring Your Own LLM** - Use a local OpenAI-compatible endpoint (e.g. Ollama, llmman, LM Studio): ```toml [profiles.offline] provider = "local" @@ -294,6 +294,13 @@ api_endpoint = "http://localhost:11434/v1" [settings] ``` +[llmman](https://github.com/llmmanorg/llmman) serves the same Ollama and OpenAI-compatible APIs on port 17434, so only the endpoint differs: +```toml +[profiles.offline.providers.offline] +type = "custom" +api_endpoint = "http://localhost:17434/v1" +``` + **Option 3: Mix Built-in and Custom Providers**: ```toml [profiles.hybrid] diff --git a/cli/src/onboarding/byom.rs b/cli/src/onboarding/byom.rs index 7de3290ed..a3067aea7 100644 --- a/cli/src/onboarding/byom.rs +++ b/cli/src/onboarding/byom.rs @@ -1,7 +1,8 @@ //! Bring Your Own Model (BYOM) / Custom Provider configuration //! //! This module provides configuration for custom OpenAI-compatible providers -//! such as Ollama, vLLM, or any other provider that implements the OpenAI API. +//! such as Ollama, llmman (, port 17434), +//! vLLM, or any other provider that implements the OpenAI API. //! //! # Configuration Format //! @@ -17,6 +18,7 @@ //! type = "custom" //! api_endpoint = "http://localhost:11434/v1" //! # api_key is optional for local providers like Ollama +//! # For llmman use api_endpoint = "http://localhost:17434/v1" //! ``` //! //! # Model Prefix Routing @@ -75,7 +77,7 @@ pub fn configure_byom( // Step 1: Provider name styled_output::render_info( - "Configure your custom OpenAI-compatible provider (e.g., LiteLLM, Ollama).", + "Configure your custom OpenAI-compatible provider (e.g., LiteLLM, Ollama, llmman).", ); println!(); diff --git a/libs/shared/src/models/llm.rs b/libs/shared/src/models/llm.rs index 928c4e637..211e32111 100644 --- a/libs/shared/src/models/llm.rs +++ b/libs/shared/src/models/llm.rs @@ -135,7 +135,7 @@ pub enum ProviderConfig { #[serde(skip_serializing_if = "Option::is_none")] auth: Option, }, - /// Custom OpenAI-compatible provider (Ollama, vLLM, etc.) + /// Custom OpenAI-compatible provider (Ollama, llmman, vLLM, etc.) /// /// The provider key in the config becomes the model prefix. /// For example, if configured as `providers.offline`, use models as: