diff --git a/docs/docs.json b/docs/docs.json index 79db465d6..fa73b7712 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -123,6 +123,7 @@ "expanded": true, "pages": [ "/integrations/claude-code", + "/integrations/codex-app", "/integrations/codex", "/integrations/copilot-cli", "/integrations/opencode", diff --git a/docs/images/codex-app-annotate.png b/docs/images/codex-app-annotate.png new file mode 100644 index 000000000..0311f10f7 Binary files /dev/null and b/docs/images/codex-app-annotate.png differ diff --git a/docs/images/codex-app-home.png b/docs/images/codex-app-home.png new file mode 100644 index 000000000..ee6e9a8e1 Binary files /dev/null and b/docs/images/codex-app-home.png differ diff --git a/docs/images/codex-app-review.png b/docs/images/codex-app-review.png new file mode 100644 index 000000000..fb0d03e24 Binary files /dev/null and b/docs/images/codex-app-review.png differ diff --git a/docs/integrations/codex-app.mdx b/docs/integrations/codex-app.mdx index f93bdbadc..13c85e2e7 100644 --- a/docs/integrations/codex-app.mdx +++ b/docs/integrations/codex-app.mdx @@ -2,38 +2,81 @@ title: Codex App --- +Codex App is OpenAI's desktop coding agent for macOS and Windows. Ollama configures the app to use Ollama's OpenAI-compatible endpoint, so Codex can work with local models and Ollama Cloud models in the desktop app. + +Codex App with Ollama selected + ## Install -Install the [Codex App](https://developers.openai.com/codex/app/overview/) for macOS or Windows. +Install the [Codex App](https://developers.openai.com/codex/quickstart/) for macOS or Windows. -## Usage with Ollama +Codex App support is available in Ollama v0.24.0 and newer. -Codex works best with a larger context window. It is recommended to use a context window of at least 64k tokens. -### Quick setup +## Quick setup ```shell ollama launch codex-app ``` -To choose a model: +Once Codex App opens, start a task or open a repository as usual. + +## Built-in browser + +Codex App can open local servers and sites in its built-in browser. Annotate directly on the page to request changes. + +Codex App browser annotations + +## Review mode + +Use review mode to inspect code changes, leave comments, and iterate on fixes without leaving the app. + +Codex App review comments + +### Run directly with a model ```shell -ollama launch codex-app --model gpt-oss:120b +ollama launch codex-app --model kimi-k2.6:cloud ``` -To configure without launching: +Use a local model by passing its model name: ```shell -ollama launch codex-app --config +ollama launch codex-app --model gemma4:31b ``` -To restore your usual Codex profile: +Running `ollama launch codex-app` is persistent and will have your model selected next time you open Codex. + + +### Restore Codex App + +To switch Codex App back to the profile you were using before `ollama launch codex-app`, run: ```shell ollama launch codex-app --restore ``` -## Backups +Ollama restores Codex App's settings and configs. If Codex App is open, Ollama asks before restarting it. + + +The Codex CLI profile managed by `ollama launch codex` is left separate from the Codex App profile. Before overwriting Codex App config files, Ollama Launch saves backups under `~/.ollama/backup/codex-app/`. On Windows, `~` resolves to your user profile directory. + +## Troubleshooting + +If Codex App does not open after setup, open Codex manually once and run `ollama launch codex-app` again. + +If Codex App is already running and does not switch models, allow Ollama to restart it when prompted, or quit Codex App and run `ollama launch codex-app` again. diff --git a/docs/integrations/index.mdx b/docs/integrations/index.mdx index 00a550643..89cd95fa6 100644 --- a/docs/integrations/index.mdx +++ b/docs/integrations/index.mdx @@ -9,8 +9,8 @@ Ollama integrates with a wide range of tools. Coding assistants that can read, modify, and execute code in your projects. - [Claude Code](/integrations/claude-code) -- [Codex CLI](/integrations/codex) - [Codex App](/integrations/codex-app) +- [Codex CLI](/integrations/codex) - [Copilot CLI](/integrations/copilot-cli) - [OpenCode](/integrations/opencode) - [Droid](/integrations/droid)