From 025d6041ed4d19a884fbf9abb9a1ca59c4282ea9 Mon Sep 17 00:00:00 2001 From: Andrey Nering Date: Mon, 10 Nov 2025 13:28:25 -0300 Subject: [PATCH] docs(readme): move "local models" section to be under "custom providers" (#1402) --- README.md | 96 +++++++++++++++++++++++++++---------------------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index a3451eb414b9e9ae04372d78aca5b44e88ea39a4..5dd30cfbec378da43693a9c3139ac12faeda4c16 100644 --- a/README.md +++ b/README.md @@ -355,54 +355,6 @@ it creates. You can customize this behavior with the `attribution` option: - `co_authored_by`: When true (default), adds `Co-Authored-By: Crush ` to commit messages - `generated_with`: When true (default), adds `💘 Generated with Crush` line to commit messages and PR descriptions -### Local Models - -Local models can also be configured via OpenAI-compatible API. Here are two common examples: - -#### Ollama - -```json -{ - "providers": { - "ollama": { - "name": "Ollama", - "base_url": "http://localhost:11434/v1/", - "type": "openai-compat", - "models": [ - { - "name": "Qwen 3 30B", - "id": "qwen3:30b", - "context_window": 256000, - "default_max_tokens": 20000 - } - ] - } - } -} -``` - -#### LM Studio - -```json -{ - "providers": { - "lmstudio": { - "name": "LM Studio", - "base_url": "http://localhost:1234/v1/", - "type": "openai-compat", - "models": [ - { - "name": "Qwen 3 30B", - "id": "qwen/qwen3-30b-a3b-2507", - "context_window": 256000, - "default_max_tokens": 20000 - } - ] - } - } -} -``` - ### Custom Providers Crush supports custom provider configurations for both OpenAI-compatible and @@ -521,6 +473,54 @@ To add specific models to the configuration, configure as such: } ``` +### Local Models + +Local models can also be configured via OpenAI-compatible API. Here are two common examples: + +#### Ollama + +```json +{ + "providers": { + "ollama": { + "name": "Ollama", + "base_url": "http://localhost:11434/v1/", + "type": "openai-compat", + "models": [ + { + "name": "Qwen 3 30B", + "id": "qwen3:30b", + "context_window": 256000, + "default_max_tokens": 20000 + } + ] + } + } +} +``` + +#### LM Studio + +```json +{ + "providers": { + "lmstudio": { + "name": "LM Studio", + "base_url": "http://localhost:1234/v1/", + "type": "openai-compat", + "models": [ + { + "name": "Qwen 3 30B", + "id": "qwen/qwen3-30b-a3b-2507", + "context_window": 256000, + "default_max_tokens": 20000 + } + ] + } + } +} +``` + ## Logging Sometimes you need to look at logs. Luckily, Crush logs all sorts of