diff --git a/docs/api/introduction.mdx b/docs/api/introduction.mdx index 596a75dbe..b2a5fa192 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/docs.json b/docs/docs.json index e98145e86..4ea6c1c83 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/images/launch-icons/claude-code.svg b/docs/images/launch-icons/claude-code.svg new file mode 100644 index 000000000..8c44152c2 --- /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 000000000..eb2e4d4b4 --- /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 000000000..db67b3446 --- /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 000000000..f31305276 --- /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 000000000..6876e04c2 --- /dev/null +++ b/docs/images/launch-icons/vscode.svg @@ -0,0 +1 @@ + diff --git a/docs/index.mdx b/docs/index.mdx index 10cc735d1..5d7e01a5a 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 3e287b5e6..0e297e369 100644 --- a/docs/integrations/claude-code.mdx +++ b/docs/integrations/claude-code.mdx @@ -4,7 +4,7 @@ title: Claude Code Claude Code is Anthropic's agentic coding tool that can read, modify, and execute code in your working directory. -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`. +You can use open models with Claude Code through Ollama's Anthropic-compatible API, including `qwen3.5`, `glm-5:cloud`, and `kimi-k2.5:cloud`. ![Claude Code with Ollama](https://files.ollama.com/claude-code.png) @@ -56,7 +56,7 @@ Run Claude Code without interaction for use in Docker, CI/CD, or scripts: 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. +The `--yes` flag auto-pulls the model, skips selectors, and requires `--model`. Arguments after `--` are passed directly to Claude Code. ## Web search @@ -64,7 +64,7 @@ Claude Code can search the web through Ollama's web search API. See the [web sea ## 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. +The `/loop` command runs a prompt or slash command on a recurring schedule inside Claude Code. Use it for repetitive tasks like checking PRs, running research, or setting reminders. ``` /loop @@ -104,7 +104,7 @@ Chat with Claude Code from Telegram by connecting a bot to your session. Install 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. +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 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. diff --git a/docs/integrations/index.mdx b/docs/integrations/index.mdx index 32951d149..8cc5499b7 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 3628e921a..3525711f9 100644 --- a/docs/integrations/opencode.mdx +++ b/docs/integrations/opencode.mdx @@ -12,7 +12,7 @@ Install the [OpenCode CLI](https://opencode.ai): curl -fsSL https://opencode.ai/install | bash ``` -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. +OpenCode requires a larger context window. Use a context window of at least 64k tokens. See [Context length](/context-length) for more information. ## Usage with Ollama diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 6f11a6779..c985d6d80 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).