From 6d510760b7c2f7a4b52f18530e8df3a424190f7b Mon Sep 17 00:00:00 2001 From: The Librarian Date: Sun, 12 Jul 2026 04:00:08 +0000 Subject: [PATCH] Sync ollama docs from 82f905cd on 2026-07-12 --- .SYNC_INFO.md | 4 +- docs/api.md | 4 +- docs/api/introduction.mdx | 4 +- docs/api/openai-compatibility.mdx | 4 +- docs/capabilities/thinking.mdx | 4 +- docs/cloud.mdx | 17 ++ docs/development.md | 4 +- docs/docs.json | 143 ++++++------ docs/faq.mdx | 2 +- docs/gpu.mdx | 11 +- docs/images/launch-icons/claude-code.svg | 1 + docs/images/launch-icons/hermes-agent.svg | 181 +++++++++++++++ docs/images/launch-icons/openclaw.svg | 242 +++++++++++++++++++++ docs/images/launch-icons/opencode.svg | 7 + docs/images/launch-icons/vscode.svg | 1 + docs/index.mdx | 58 +++-- docs/integrations/claude-code.mdx | 254 +++++++++++++--------- docs/integrations/hermes.mdx | 2 +- docs/integrations/index.mdx | 70 +++--- docs/integrations/opencode.mdx | 144 ++++++++++-- docs/openapi.yaml | 8 +- docs/quickstart.mdx | 59 +++-- docs/styling.css | 101 +++++++++ docs/windows.mdx | 2 +- 24 files changed, 1013 insertions(+), 314 deletions(-) create mode 100644 docs/images/launch-icons/claude-code.svg create mode 100644 docs/images/launch-icons/hermes-agent.svg create mode 100644 docs/images/launch-icons/openclaw.svg create mode 100644 docs/images/launch-icons/opencode.svg create mode 100644 docs/images/launch-icons/vscode.svg diff --git a/.SYNC_INFO.md b/.SYNC_INFO.md index 8f35809..3bf64e0 100644 --- a/.SYNC_INFO.md +++ b/.SYNC_INFO.md @@ -4,8 +4,8 @@ This is a mirror of the Ollama repository. **Synced from:** https://github.com/ollama/ollama.git **Branch:** main -**Commit:** 12e04379cd5a9a2f150104a02c5761213f4be777 -**Sync Date:** 2026-06-12 +**Commit:** 82f905cd9c06c6f0254d74c5326aa2a7f2f07e1f +**Sync Date:** 2026-07-12 **Content:** Paths: docs --- diff --git a/docs/api.md b/docs/api.md index 2bcb68b..fbc2452 100644 --- a/docs/api.md +++ b/docs/api.md @@ -46,7 +46,7 @@ Generate a response for a given prompt with a provided model. This is a streamin - `prompt`: the prompt to generate a response for - `suffix`: the text after the model response - `images`: (optional) a list of base64-encoded images (for multimodal models such as `llava`) -- `think`: (for thinking models) should the model think before responding? +- `think`: (for thinking models) should the model think before responding? Can be a boolean or a thinking level (`"low"`, `"medium"`, `"high"`, or `"max"`). Advanced parameters (optional): @@ -504,7 +504,7 @@ Generate the next message in a chat with a provided model. This is a streaming e - `model`: (required) the [model name](#model-names) - `messages`: the messages of the chat, this can be used to keep a chat memory - `tools`: list of tools in JSON for the model to use if supported -- `think`: (for thinking models) should the model think before responding? +- `think`: (for thinking models) should the model think before responding? Can be a boolean or a thinking level (`"low"`, `"medium"`, `"high"`, or `"max"`). The `message` object has the following fields: diff --git a/docs/api/introduction.mdx b/docs/api/introduction.mdx index 596a75d..b2a5fa1 100644 --- a/docs/api/introduction.mdx +++ b/docs/api/introduction.mdx @@ -2,11 +2,11 @@ title: Introduction --- -Ollama's API allows you to run and interact with models programatically. +Use Ollama's API to run and interact with models. ## Get started -If you're just getting started, follow the [quickstart](/quickstart) documentation to get up and running with Ollama's API. +Follow the [quickstart](/quickstart) to install Ollama and make your first request. ## Base URL diff --git a/docs/api/openai-compatibility.mdx b/docs/api/openai-compatibility.mdx index ddf93d2..a74a23f 100644 --- a/docs/api/openai-compatibility.mdx +++ b/docs/api/openai-compatibility.mdx @@ -208,9 +208,9 @@ curl -X POST http://localhost:11434/v1/chat/completions \ - [x] `top_p` - [x] `max_tokens` - [x] `tools` -- [x] `reasoning_effort` (`"high"`, `"medium"`, `"low"`, `"none"`) +- [x] `reasoning_effort` (`"high"`, `"medium"`, `"low"`, `"max"`, `"none"`) - [x] `reasoning` - - [x] `effort` (`"high"`, `"medium"`, `"low"`, `"none"`) + - [x] `effort` (`"high"`, `"medium"`, `"low"`, `"max"`, `"none"`) - [ ] `tool_choice` - [ ] `logit_bias` - [ ] `user` diff --git a/docs/capabilities/thinking.mdx b/docs/capabilities/thinking.mdx index 388e985..4e58c1d 100644 --- a/docs/capabilities/thinking.mdx +++ b/docs/capabilities/thinking.mdx @@ -16,9 +16,9 @@ Use this capability to audit model steps, animate the model *thinking* in a UI, ## Enable thinking in API calls -Set the `think` field on chat or generate requests. Most models accept booleans (`true`/`false`). +Set the `think` field on chat or generate requests. Most models accept booleans (`true`/`false`) or levels (`low`, `medium`, `high`, `max`), where `max` requests the highest thinking level. -GPT-OSS instead expects one of `low`, `medium`, or `high` to tune the trace length. +GPT-OSS instead expects one of `low`, `medium`, or `high` to tune the trace length. The `message.thinking` (chat endpoint) or `thinking` (generate endpoint) field contains the reasoning trace while `message.content` / `response` holds the final answer. diff --git a/docs/cloud.mdx b/docs/cloud.mdx index b994e96..cf5ee7d 100644 --- a/docs/cloud.mdx +++ b/docs/cloud.mdx @@ -252,3 +252,20 @@ Ollama Cloud model retirement does not affect local models. | June 16, 2026 | `qwen3-vl:235b` | `qwen3.5` | | June 16, 2026 | `qwen3-vl:235b-instruct` | `qwen3.5` | | June 16, 2026 | `cogito-2.1:671b` | `deepseek-v4-flash` | +| June 30, 2026 | `rnj-1:8b` | | +| July 15, 2026 | `deepseek-v3.1:671b` | `deepseek-v4-flash` | +| July 15, 2026 | `deepseek-v3.2` | `deepseek-v4-flash` | +| July 15, 2026 | `devstral-2:123b` | `mistral-large-3:675b` | +| July 15, 2026 | `devstral-small-2:24b` | | +| July 15, 2026 | `ministral-3:14b` | | +| July 15, 2026 | `ministral-3:3b` | | +| July 15, 2026 | `ministral-3:8b` | | +| July 15, 2026 | `gemini-3-flash-preview` | `minimax-m3` | +| July 15, 2026 | `gemma3:12b` | `gemma4:31b` | +| July 15, 2026 | `gemma3:27b` | `gemma4:31b` | +| July 15, 2026 | `gemma3:4b` | `gemma4:31b` | +| July 15, 2026 | `glm-4.7` | `glm-5.2` | +| July 15, 2026 | `glm-5` | `glm-5.2` | +| July 15, 2026 | `minimax-m2.1` | `minimax-m3` | +| July 15, 2026 | `qwen3-coder-next` | `qwen3.5:397b` | +| July 15, 2026 | `qwen3-coder:480b` | `qwen3.5:397b` | diff --git a/docs/development.md b/docs/development.md index ef28cee..dec7b55 100644 --- a/docs/development.md +++ b/docs/development.md @@ -51,10 +51,10 @@ cmake -B build . -DOLLAMA_LLAMA_BACKENDS=cuda_v13 -DCMAKE_CUDA_ARCHITECTURES=nat cmake -B build . -DOLLAMA_LLAMA_BACKENDS=rocm_v7_2 -DCMAKE_HIP_ARCHITECTURES=gfx1100 ``` -You can tune GGML build options by setting `GGML_*` values during configure. For example, to build CUDA v12 for Pascal without flash attention kernels: +You can tune GGML build options by setting `GGML_*` values during configure. For example, to disable CUDA flash attention kernels for local debugging: ```shell -cmake -B build . -DOLLAMA_LLAMA_BACKENDS=cuda_v12 -DCMAKE_CUDA_ARCHITECTURES=61 -DGGML_CUDA_FA=OFF +cmake -B build . -DOLLAMA_LLAMA_BACKENDS=cuda_v12 -DGGML_CUDA_FA=OFF ``` ## macOS (Apple Silicon) diff --git a/docs/docs.json b/docs/docs.json index e98145e..4ea6c1c 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -84,7 +84,7 @@ "navigation": { "tabs": [ { - "tab": "Documentation", + "tab": "Guide", "groups": [ { "group": "Get started", @@ -106,78 +106,10 @@ "/capabilities/web-search" ] }, - { - "group": "Integrations", - "pages": [ - "/integrations/index", - { - "group": "Assistants", - "expanded": true, - "pages": [ - "/integrations/openclaw", - "/integrations/hermes", - "/integrations/hermes-desktop" - ] - }, - { - "group": "Coding", - "expanded": true, - "pages": [ - "/integrations/claude-code", - "/integrations/codex-app", - "/integrations/codex", - "/integrations/copilot-cli", - "/integrations/cline-cli", - "/integrations/opencode", - "/integrations/droid", - "/integrations/goose", - "/integrations/oh-my-pi", - "/integrations/pi", - "/integrations/pool" - ] - }, - { - "group": "IDEs & Editors", - "expanded": true, - "pages": [ - "/integrations/cline", - "/integrations/jetbrains", - "/integrations/roo-code", - "/integrations/vscode", - "/integrations/xcode", - "/integrations/zed" - ] - }, - { - "group": "Chat & RAG", - "pages": [ - "/integrations/onyx" - ] - }, - { - "group": "Automation", - "pages": [ - "/integrations/n8n" - ] - }, - { - "group": "Notebooks", - "pages": [ - "/integrations/marimo" - ] - } - ] - }, { "group": "More information", "pages": [ "/cli", - { - "group": "Assistant Sandboxing", - "pages": [ - "/integrations/nemoclaw" - ] - }, "/modelfile", "/context-length", "/linux", @@ -192,6 +124,79 @@ } ] }, + { + "tab": "Integrations", + "groups": [ + { + "group": "Integrations", + "pages": [ + "/integrations/index" + ] + }, + { + "group": "Assistants", + "expanded": true, + "pages": [ + "/integrations/openclaw", + "/integrations/hermes", + "/integrations/hermes-desktop" + ] + }, + { + "group": "Coding", + "expanded": true, + "pages": [ + "/integrations/claude-code", + "/integrations/opencode", + "/integrations/cline-cli", + "/integrations/codex-app", + "/integrations/codex", + "/integrations/copilot-cli", + "/integrations/droid", + "/integrations/goose", + "/integrations/oh-my-pi", + "/integrations/pi", + "/integrations/pool" + ] + }, + { + "group": "IDEs & Editors", + "expanded": true, + "pages": [ + "/integrations/vscode", + "/integrations/cline", + "/integrations/jetbrains", + "/integrations/roo-code", + "/integrations/xcode", + "/integrations/zed" + ] + }, + { + "group": "Chat & RAG", + "pages": [ + "/integrations/onyx" + ] + }, + { + "group": "Automation", + "pages": [ + "/integrations/n8n" + ] + }, + { + "group": "Notebooks", + "pages": [ + "/integrations/marimo" + ] + }, + { + "group": "Assistant Sandboxing", + "pages": [ + "/integrations/nemoclaw" + ] + } + ] + }, { "tab": "API Reference", "openapi": "/openapi.yaml", diff --git a/docs/faq.mdx b/docs/faq.mdx index 47f0652..7cedace 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -343,7 +343,7 @@ When loading a new model, Ollama evaluates the required VRAM for the model again ## How can I enable Flash Attention? -Flash Attention is a feature of most modern models that can significantly reduce memory usage as the context size grows. To enable Flash Attention, set the `OLLAMA_FLASH_ATTENTION` environment variable to `1` when starting the Ollama server. +Flash Attention is a feature of most modern models that can significantly reduce memory usage as the context size grows. Ollama uses Flash Attention automatically when the selected backend and devices support it. To force Flash Attention on, set `OLLAMA_FLASH_ATTENTION=1` when starting the Ollama server. To disable it, set `OLLAMA_FLASH_ATTENTION=0`. ## How can I set the quantization type for the K/V cache? diff --git a/docs/gpu.mdx b/docs/gpu.mdx index 1394fc7..32c5f68 100644 --- a/docs/gpu.mdx +++ b/docs/gpu.mdx @@ -3,7 +3,7 @@ title: Hardware support --- ## Nvidia -Ollama supports Nvidia GPUs with compute capability 5.0+ and driver version 531 and newer. +Ollama supports Nvidia GPUs with compute capability 5.0+ and driver version 550 and newer. Nvidia GPUs with compute capability 5.0 through 6.2 require driver version 570 or newer. Check your compute compatibility to see if your card is supported: @@ -68,7 +68,7 @@ using the `amdgpu-install` utility from | Family | Cards and accelerators | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| AMD Radeon RX | `9070 XT` `9070 GRE` `9070` `9060 XT` `9060 XT LP` `9060` `7900 XTX` `7900 XT` `7900 GRE` `7800 XT` `7700 XT` `7700` `7600 XT` `7600` `6950 XT` `6900 XTX` `6900XT` `6800 XT` `6800` `5700 XT` `5700` `5600 XT` `5500 XT` | +| AMD Radeon RX | `9070 XT` `9070 GRE` `9070` `9060 XT` `9060 XT LP` `9060` `7900 XTX` `7900 XT` `7900 GRE` `7800 XT` `7700 XT` `7700` `7600 XT` `7600` `6950 XT` `6900 XTX` `6900XT` `6800 XT` `6800` | | AMD Radeon AI PRO | `R9700` `R9600D` | | AMD Radeon PRO | `W7900` `W7800` `W7700` `W7600` `W7500` `W6900X` `W6800X Duo` `W6800X` `W6800` `V620` | | AMD Ryzen AI | `Ryzen AI Max+ 395` `Ryzen AI Max 390` `Ryzen AI Max 385` `Ryzen AI 9 HX 475` `Ryzen AI 9 HX 470` `Ryzen AI 9 465` `Ryzen AI 9 HX 375` `Ryzen AI 9 HX 370` `Ryzen AI 9 365` | @@ -80,8 +80,8 @@ Ollama requires an AMD ROCm v7 / HIP7-capable driver stack on Windows. | Family | Cards and accelerators | | -------------- | -------------------------------------------------------------------------------------------------------------------- | -| AMD Radeon RX | `7900 XTX` `7900 XT` `7900 GRE` `7800 XT` `7700 XT` `7600 XT` `7600` `6950 XT` `6900 XTX` `6900XT` `6800 XT` `6800` | -| AMD Radeon PRO | `W7900` `W7800` `W7700` `W7600` `W7500` `W6900X` `W6800X Duo` `W6800X` `W6800` `V620` | +| AMD Radeon RX | `7900 XTX` `7900 XT` `7900 GRE` `7800 XT` `7700 XT` `7600 XT` `7600` | +| AMD Radeon PRO | `W7900` `W7800` `W7700` `W7600` `W7500` | ### Overrides on Linux @@ -107,13 +107,10 @@ This table shows some example GPUs that map to these LLVM targets: | gfx90a | Radeon Instinct MI210/MI250 | | gfx942 | Radeon Instinct MI300X/MI300A | | gfx950 | Radeon Instinct MI350X | -| gfx1010 | Radeon RX 5700 XT | -| gfx1012 | Radeon RX 5500 XT | | gfx1030 | Radeon PRO V620 | | gfx1100 | Radeon PRO W7900 | | gfx1101 | Radeon PRO W7700 | | gfx1102 | Radeon RX 7600 | -| gfx1103 | Radeon 780M | | gfx1150 | Ryzen AI 9 HX 375 | | gfx1151 | Ryzen AI Max+ 395 | | gfx1200 | Radeon RX 9070 | diff --git a/docs/images/launch-icons/claude-code.svg b/docs/images/launch-icons/claude-code.svg new file mode 100644 index 0000000..8c44152 --- /dev/null +++ b/docs/images/launch-icons/claude-code.svg @@ -0,0 +1 @@ +Claude Code diff --git a/docs/images/launch-icons/hermes-agent.svg b/docs/images/launch-icons/hermes-agent.svg new file mode 100644 index 0000000..eb2e4d4 --- /dev/null +++ b/docs/images/launch-icons/hermes-agent.svg @@ -0,0 +1,181 @@ + + + + + + + diff --git a/docs/images/launch-icons/openclaw.svg b/docs/images/launch-icons/openclaw.svg new file mode 100644 index 0000000..db67b34 --- /dev/null +++ b/docs/images/launch-icons/openclaw.svg @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/launch-icons/opencode.svg b/docs/images/launch-icons/opencode.svg new file mode 100644 index 0000000..f313052 --- /dev/null +++ b/docs/images/launch-icons/opencode.svg @@ -0,0 +1,7 @@ + + + + + diff --git a/docs/images/launch-icons/vscode.svg b/docs/images/launch-icons/vscode.svg new file mode 100644 index 0000000..6876e04 --- /dev/null +++ b/docs/images/launch-icons/vscode.svg @@ -0,0 +1 @@ + diff --git a/docs/index.mdx b/docs/index.mdx index 10cc735..5d7e01a 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,47 +1,45 @@ --- -title: Ollama's documentation +title: Ollama documentation sidebarTitle: Welcome --- - +Start building with open models. -[Ollama](https://ollama.com) is the easiest way to get up and running with large language models such as gpt-oss, Gemma 4, DeepSeek-R1, Qwen3 and more. +Follow the [quickstart](/quickstart), then choose a model, integration, or API. + +## Models + +Run models locally or use larger models in Ollama's cloud. - - Get up and running with your first model or integrate Ollama with your favorite tools + + Find models for chat, coding, vision, embeddings, and reasoning. - - Download Ollama on macOS, Windows or Linux - - - Ollama's cloud models offer larger models with better performance. - - - View Ollama's API reference + + + Run larger models on Ollama's Cloud without the download. -## Libraries +## Next steps + +Connect Ollama to an app, or build with the API. - - The official library for using Ollama with Python + + Connect Ollama to an app, editor, or agent. - - The official library for using Ollama with JavaScript or TypeScript. + + Learn the local and cloud base URLs, then send a request with `curl`. - - View a list of 20+ community-supported libraries for Ollama + + + Use Ollama from Python. + + + + Use Ollama from JavaScript or TypeScript. @@ -49,10 +47,10 @@ sidebarTitle: Welcome - Join our Discord community + Join the Ollama Discord. - Join our Reddit community + Join the Ollama subreddit. diff --git a/docs/integrations/claude-code.mdx b/docs/integrations/claude-code.mdx index 3e287b5..499b8c8 100644 --- a/docs/integrations/claude-code.mdx +++ b/docs/integrations/claude-code.mdx @@ -2,15 +2,162 @@ title: Claude Code --- -Claude Code is Anthropic's agentic coding tool that can read, modify, and execute code in your working directory. +[Claude Code](https://code.claude.com/docs/en/overview) is an agentic coding tool that reads your codebase, edits files, and runs commands. -Open models can be used with Claude Code through Ollama's Anthropic-compatible API, enabling you to use models such as `qwen3.5`, `glm-5:cloud`, `kimi-k2.5:cloud`. +Ollama connects Claude Code to local and cloud models through its Anthropic-compatible API. -![Claude Code with Ollama](https://files.ollama.com/claude-code.png) +## Get started -## Install +Launch Claude Code with Ollama: -Install [Claude Code](https://code.claude.com/docs/en/overview): +```shell +ollama launch claude +``` + +## Capabilities + +
+
+
+
+
+
Chat
+
Ask questions about a repository or task
+
+
+ +
+
+
+
Command line
+
Run commands with Claude Code's permission flow
+
+
+ +
+
+
+
Tool calling
+
Use tools with compatible models
+
+
+ +
+
+
+
File edits
+
Read and edit files in your project
+
+
+ +
+
+
+
Subagents
+
Split work across tasks
+
+
+ +
+
+
+
Web search
+
Search the web through Ollama
+
+
+ +
+
+
+
Web fetch
+
Fetch and summarize web pages
+
+
+ +
+
+
+
Vision
+
Send images and screenshots
+
+
+ +
+
+
+
Thinking
+
Use thinking controls with compatible models
+
+
+ +
+
+ +## Models + +Choose a model with enough context for your repository. + + + + Use larger models without downloading them. + + + + Choose a model and set a 64k+ context window. + + + +For larger repositories, set the [context length](/context-length) to 64k or higher. + +## More features + +### Run without interaction + +Use `--yes` for scripts, Docker, or CI: + +```shell +ollama launch claude --model gemma4:cloud --yes -- -p "how does this repository work?" +``` + +The `--yes` flag skips selectors, pulls the model when needed, and requires `--model`. Arguments after `--` are passed directly to Claude Code. + +### Web search + +Use Ollama's web search API from Claude Code. + +See [Web search](/capabilities/web-search) for setup and usage. + +### Scheduled tasks with `/loop` + +Use `/loop` inside Claude Code to run a prompt or slash command on a schedule: + +```text +/loop +``` + +Examples: + +```text +/loop 30m Check my open PRs and summarize their status +/loop 1h Research the latest AI news and summarize key developments +/loop 15m Check for new GitHub issues and triage by priority +``` + +### Telegram + +Connect a Telegram bot to your Claude Code session. Install the [Telegram plugin](https://github.com/anthropics/claude-plugins-official), create a bot with [@BotFather](https://t.me/BotFather), then launch Claude Code: + +```shell +ollama launch claude -- --channels plugin:telegram@claude-plugins-official +``` + +Claude Code prompts for permission on most actions. To allow the bot to work autonomously, configure [permission rules](https://code.claude.com/docs/en/permissions) or pass `--dangerously-skip-permissions` in an isolated environment. + +See the [plugin README](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/telegram) for setup instructions. + +## Manual setup + +

1. Install Claude Code

@@ -24,95 +171,7 @@ irm https://claude.ai/install.ps1 | iex -## Usage with Ollama - -### Quick setup - -```shell -ollama launch claude -``` - -### Run directly with a model -```shell -ollama launch claude --model kimi-k2.5:cloud -``` - -## Recommended Models - -- `kimi-k2.5:cloud` -- `glm-5:cloud` -- `minimax-m2.7:cloud` -- `qwen3.5:cloud` -- `glm-4.7-flash` -- `qwen3.5` - -Cloud models are also available at [ollama.com/search?c=cloud](https://ollama.com/search?c=cloud). - -## Non-interactive (headless) mode - -Run Claude Code without interaction for use in Docker, CI/CD, or scripts: - -```shell -ollama launch claude --model kimi-k2.5:cloud --yes -- -p "how does this repository work?" -``` - -The `--yes` flag auto-pulls the model, skips selectors, and requires `--model` to be specified. Arguments after `--` are passed directly to Claude Code. - -## Web search - -Claude Code can search the web through Ollama's web search API. See the [web search documentation](/capabilities/web-search) for setup and usage. - -## Scheduled Tasks with `/loop` - -The `/loop` command runs a prompt or slash command on a recurring schedule inside Claude Code. This is useful for automating repetitive tasks like checking PRs, running research, or setting reminders. - -``` -/loop -``` - -### Examples - -**Check in on your PRs** - -``` -/loop 30m Check my open PRs and summarize their status -``` - -**Automate research tasks** - -``` -/loop 1h Research the latest AI news and summarize key developments -``` - -**Automate bug reporting and triaging** - -``` -/loop 15m Check for new GitHub issues and triage by priority -``` - -**Set reminders** - -``` -/loop 1h Remind me to review the deploy status -``` - -## Telegram - -Chat with Claude Code from Telegram by connecting a bot to your session. Install the [Telegram plugin](https://github.com/anthropics/claude-plugins-official), create a bot via [@BotFather](https://t.me/BotFather), then launch with the channel flag: - -```shell -ollama launch claude -- --channels plugin:telegram@claude-plugins-official -``` - -Claude Code will prompt for permission on most actions. To allow the bot to work autonomously, configure [permission rules](https://code.claude.com/docs/en/permissions) or pass `--dangerously-skip-permissions` in isolated environments. - -See the [plugin README](https://github.com/anthropics/claude-plugins-official/tree/main/external_plugins/telegram) for full setup instructions including pairing and access control. - -## Manual setup - -Claude Code connects to Ollama using the Anthropic-compatible API. - -1. Set the environment variables: +

2. Set the environment variables

```shell export ANTHROPIC_AUTH_TOKEN=ollama @@ -120,7 +179,7 @@ export ANTHROPIC_API_KEY="" export ANTHROPIC_BASE_URL=http://localhost:11434 ``` -2. Run Claude Code with an Ollama model: +

3. Run Claude Code

```shell claude --model qwen3.5 @@ -129,8 +188,5 @@ claude --model qwen3.5 Or run with environment variables inline: ```shell -ANTHROPIC_AUTH_TOKEN=ollama ANTHROPIC_BASE_URL=http://localhost:11434 ANTHROPIC_API_KEY="" claude --model glm-5:cloud +ANTHROPIC_AUTH_TOKEN=ollama ANTHROPIC_BASE_URL=http://localhost:11434 ANTHROPIC_API_KEY="" claude --model kimi-k2.7-code:cloud ``` - -**Note:** Claude Code requires a large context window. We recommend at least 64k tokens. See the [context length documentation](/context-length) for how to adjust context length in Ollama. - diff --git a/docs/integrations/hermes.mdx b/docs/integrations/hermes.mdx index fc0921f..99dda32 100644 --- a/docs/integrations/hermes.mdx +++ b/docs/integrations/hermes.mdx @@ -56,7 +56,7 @@ hermes setup If you'd rather drive Hermes's own wizard instead of `ollama launch hermes`, install it directly: ```bash -curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash +curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash ``` Hermes launches the setup wizard automatically. Choose **Quick setup**: diff --git a/docs/integrations/index.mdx b/docs/integrations/index.mdx index 32951d1..8cc5499 100644 --- a/docs/integrations/index.mdx +++ b/docs/integrations/index.mdx @@ -2,57 +2,43 @@ title: Overview --- -Ollama integrates with a wide range of tools. +Use Ollama from coding agents, personal assistants, and editors. -## Coding Agents +Run `ollama launch` to see the latest integrations you can run from the terminal. -Coding assistants that can read, modify, and execute code in your projects. +## Code in the terminal -- [Claude Code](/integrations/claude-code) -- [Codex App](/integrations/codex-app) -- [Codex CLI](/integrations/codex) -- [Copilot CLI](/integrations/copilot-cli) -- [Cline CLI](/integrations/cline-cli) -- [OpenCode](/integrations/opencode) -- [Droid](/integrations/droid) -- [Goose](/integrations/goose) -- [Oh My Pi](/integrations/oh-my-pi) -- [Pi](/integrations/pi) -- [Pool](/integrations/pool) -## Assistants + + + Terminal coding agent with tools, vision, web search, and long context. + -AI assistants that help with everyday tasks. + + Open-source coding agent that edits, runs, and iterates on code. + + -- [OpenClaw](/integrations/openclaw) -- [Hermes Agent](/integrations/hermes) -- [Hermes Desktop](/integrations/hermes-desktop) +## Connect an assistant -## IDEs & Editors +Assistants with memory, skills, and messaging app access. -Native integrations for popular development environments. + + + Personal assistant for messaging apps and everyday tasks. + -- [VS Code](/integrations/vscode) -- [Cline](/integrations/cline) -- [Roo Code](/integrations/roo-code) -- [JetBrains](/integrations/jetbrains) -- [Xcode](/integrations/xcode) -- [Zed](/integrations/zed) + + Open-source agent with self-improving skills, memory, and messaging. + + -## Chat & RAG +## Work in your editor -Chat interfaces and retrieval-augmented generation platforms. +Use Ollama models inside your editor. -- [Onyx](/integrations/onyx) - -## Automation - -Workflow automation platforms with AI integration. - -- [n8n](/integrations/n8n) - -## Notebooks - -Interactive computing environments with AI capabilities. - -- [marimo](/integrations/marimo) + + + Select Ollama models from the Copilot Chat model picker in VS Code. + + diff --git a/docs/integrations/opencode.mdx b/docs/integrations/opencode.mdx index 3628e92..12a9cb3 100644 --- a/docs/integrations/opencode.mdx +++ b/docs/integrations/opencode.mdx @@ -2,30 +2,144 @@ title: OpenCode --- -OpenCode is an open-source AI coding assistant that runs in your terminal. +[OpenCode](https://opencode.ai) is an open-source coding agent that runs in your terminal, reads your project, edits files, and runs commands. -## Install +Ollama configures OpenCode to use local and cloud models. -Install the [OpenCode CLI](https://opencode.ai): +## Get started -```bash -curl -fsSL https://opencode.ai/install | bash -``` +Launch OpenCode with Ollama: -OpenCode requires a larger context window. It is recommended to use a context window of at least 64k tokens. See [Context length](/context-length) for more information. - -## Usage with Ollama - -### Quick setup - -```bash +```shell ollama launch opencode ``` -To configure without launching: +## Capabilities + +
+
+
+
+
+
Chat
+
Ask questions about a repository or task
+
+
+ +
+
+
+
Command line
+
Run commands from your working directory
+
+
+ +
+
+
+
File edits
+
Read and edit files in your project
+
+
+ +
+
+
+
Subagents
+
Split work across tasks
+
+
+ +
+
+
+
Web fetch
+
Fetch and summarize web pages
+
+
+ +
+
+
+
Vision
+
Send images and screenshots
+
+
+
+
+ +## Models + +Choose a model with enough context for your repository. + + + + Use larger models without downloading them. + + + + Choose a model and set a 64k+ context window. + + + +OpenCode requires a context length of 64k or higher. See [Context length](/context-length) for more information. + +## Manual setup + +

1. Install OpenCode

+ + + +```shell macOS / Linux +curl -fsSL https://opencode.ai/install | bash +``` + +```powershell Windows +npm install -g opencode-ai +``` + + + +

2. Configure Ollama as a provider

+ +Add an Ollama provider to `opencode.json`: + +```json +{ + "$schema": "https://opencode.ai/config.json", + "provider": { + "ollama": { + "npm": "@ai-sdk/openai-compatible", + "name": "Ollama", + "options": { + "baseURL": "http://localhost:11434/v1" + }, + "models": { + "qwen3.5": { + "name": "qwen3.5" + } + } + } + } +} +``` + +

3. Run OpenCode

+ +```shell +opencode +``` + +To configure OpenCode with Ollama without starting an interactive session: ```shell ollama launch opencode --config ``` -`ollama launch opencode` passes its configuration to OpenCode inline via the `OPENCODE_CONFIG_CONTENT` environment variable. OpenCode deep-merges its config sources on startup, so anything you declare in `~/.config/opencode/opencode.json` is still respected and available inside OpenCode. Models declared only in `opencode.json` won't appear in `ollama launch`'s model-selection menu. +### Configuration precedence + +`ollama launch opencode` starts OpenCode with an inline config for the selected Ollama model. It does not overwrite `~/.config/opencode/opencode.json`; existing OpenCode settings still apply. + +Models defined only in `opencode.json` do not appear in the `ollama launch` model picker. + +See OpenCode's [config precedence](https://opencode.ai/docs/config/#precedence-order). diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 26b122f..e4ee55f 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -99,8 +99,8 @@ components: oneOf: - type: boolean - type: string - enum: [high, medium, low] - description: When true, returns separate thinking output in addition to content. Can be a boolean (true/false) or a string ("high", "medium", "low") for supported models. + enum: [high, medium, low, max] + description: When true, returns separate thinking output in addition to content. Can be a boolean (true/false) or a string ("high", "medium", "low", "max") for supported models, with "max" requesting the highest thinking level. raw: type: boolean description: When true, returns the raw response from the model without any prompt templating @@ -291,8 +291,8 @@ components: oneOf: - type: boolean - type: string - enum: [high, medium, low] - description: When true, returns separate thinking output in addition to content. Can be a boolean (true/false) or a string ("high", "medium", "low") for supported models. + enum: [high, medium, low, max] + description: When true, returns separate thinking output in addition to content. Can be a boolean (true/false) or a string ("high", "medium", "low", "max") for supported models, with "max" requesting the highest thinking level. keep_alive: oneOf: - type: string diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 6f11a67..c985d6d 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -2,7 +2,11 @@ title: Quickstart --- -Ollama is available on macOS, Windows, and Linux. +Install Ollama and get your first response. + +## 1. Download Ollama + +Ollama runs on macOS, Windows, and Linux. -## Get Started +## 2. Open the menu Run `ollama` in your terminal to open the interactive menu: -```sh +```shell ollama ``` -Navigate with `↑/↓`, press `enter` to launch, `→` to change model, and `esc` to quit. +From the menu you can: -The menu provides quick access to: - **Run a model** - Start an interactive chat -- **Launch tools** - Claude Code, Codex, OpenClaw, and more -- **Additional integrations** - Available under "More..." +- **Launch tools** - [Claude Code](/integrations/claude-code), [OpenClaw](/integrations/openclaw), [VS Code](/integrations/vscode), and more -## Assistants +## 3. Start a chat -Launch [OpenClaw](/integrations/openclaw), a personal AI with 100+ skills: +Run a model to start your first chat. -```sh -ollama launch openclaw +```shell +ollama run gemma4 ``` -## Coding +Cloud models work the same way: -Launch [Claude Code](/integrations/claude-code) and other coding tools with Ollama models: - -```sh -ollama launch claude +```shell +ollama run gemma4:cloud ``` -```sh -ollama launch codex +Send your first message: + +```text +Explain why the sky is blue in one paragraph. ``` -```sh -ollama launch opencode +To leave the chat, type: + +```shell +/bye ``` -See [integrations](/integrations) for all supported tools. +## Next steps -## API - -Use the [API](/api) to integrate Ollama into your applications: - -```sh -curl http://localhost:11434/api/chat -d '{ - "model": "gemma4", - "messages": [{ "role": "user", "content": "Hello!" }] -}' -``` - -See the [API documentation](/api) for Python, JavaScript, and other integrations. +Use a model with an [integration](/integrations), make an [API request](/api/introduction), or browse more [models](https://ollama.com/search). diff --git a/docs/styling.css b/docs/styling.css index e63b6be..6ddcc83 100644 --- a/docs/styling.css +++ b/docs/styling.css @@ -14,3 +14,104 @@ pre, code, .font-mono { color: #666; font-weight: 400; } + +.capability-list { + border-top: 1px solid #e5e5e5; + border-bottom: 1px solid #e5e5e5; + display: grid; + gap: 2rem; + grid-template-columns: 7rem minmax(0, 1fr); + margin: 1.5rem 0 2rem; + padding: 2rem 0; +} + +.capability-list-title { + color: #171717; + font-size: 1rem; + line-height: 1.5rem; +} + +.capability-list-full { + grid-template-columns: 1fr; +} + +.capability-list-grid { + display: grid; + gap: 1.75rem 2rem; + grid-template-columns: repeat(2, minmax(0, 1fr)); + min-width: 0; +} + +.capability-list-item { + align-items: flex-start; + display: grid; + gap: 0.75rem; + grid-template-columns: 2rem minmax(0, 1fr); + min-width: 0; +} + +.capability-list-icon { + align-items: center; + background: #f1f1f1; + border-radius: 0.75rem; + color: #171717; + display: flex; + height: 2rem; + justify-content: center; + width: 2rem; +} + +.capability-list-icon svg { + height: 1rem; + width: 1rem; +} + +.capability-list-heading { + color: #171717; + font-size: 1rem; + font-weight: 600; + line-height: 1.375rem; +} + +.capability-list-copy { + color: #737373; + font-size: 0.95rem; + line-height: 1.375rem; +} + +.manual-step-title { + color: #171717; + font-size: 0.95rem; + font-weight: 600; + line-height: 1.375rem; + margin: 1.25rem 0 0.75rem; +} + +.dark .capability-list { + border-color: #262626; +} + +.dark .capability-list-title, +.dark .capability-list-heading, +.dark .manual-step-title { + color: #fafafa; +} + +.dark .capability-list-icon { + background: #262626; + color: #fafafa; +} + +.dark .capability-list-copy { + color: #a3a3a3; +} + +@media (max-width: 920px) { + .capability-list { + grid-template-columns: 1fr; + } + + .capability-list-grid { + grid-template-columns: 1fr; + } +} diff --git a/docs/windows.mdx b/docs/windows.mdx index 297febd..4e52bf1 100644 --- a/docs/windows.mdx +++ b/docs/windows.mdx @@ -11,7 +11,7 @@ terminal application. As usual the Ollama [API](/api) will be served on ## System Requirements - Windows 10 22H2 or newer, Home or Pro -- NVIDIA 452.39 or newer Drivers if you have an NVIDIA card +- NVIDIA 551.61 or newer Drivers if you have an NVIDIA card - AMD ROCm v7 / HIP7-capable driver stack for ROCm acceleration, or a Vulkan-capable AMD Radeon driver for Vulkan acceleration Ollama uses unicode characters for progress indication, which may render as unknown squares in some older terminal fonts in Windows 10. If you see this, try changing your terminal font settings.