diff --git a/services/site/src/docs/content/agents.mdx b/services/site/src/docs/content/agents.mdx index 6538c3401f57..50faee8424ca 100644 --- a/services/site/src/docs/content/agents.mdx +++ b/services/site/src/docs/content/agents.mdx @@ -1,5 +1,6 @@ --- title: "Agents" +description: "Define reusable agents in Markdown or config, each with its own system prompt, model, permissions, and mode." --- Create a Markdown file to add a reusable agent. This example adds a read-only reviewer that the main agent can launch for code reviews: diff --git a/services/site/src/docs/content/attachments.mdx b/services/site/src/docs/content/attachments.mdx index 6a7342b7679a..5ddf09e77202 100644 --- a/services/site/src/docs/content/attachments.mdx +++ b/services/site/src/docs/content/attachments.mdx @@ -1,5 +1,6 @@ --- title: "Attachments" +description: "Attach files, directories, and images to OpenCode prompts, and see what the model receives for each format." --- ## Attach diff --git a/services/site/src/docs/content/build/client/effect.mdx b/services/site/src/docs/content/build/client/effect.mdx index 938f2941d4d9..70f587db3d93 100644 --- a/services/site/src/docs/content/build/client/effect.mdx +++ b/services/site/src/docs/content/build/client/effect.mdx @@ -1,5 +1,6 @@ --- -title: "Effect" +title: "Effect client" +description: "Call the OpenCode HTTP API from Effect with @opencode/client/effect, which returns typed Effects and Streams." --- `@opencode/client/effect` is the Effect-native client for the OpenCode HTTP API. It returns typed Effects and Streams diff --git a/services/site/src/docs/content/build/client/index.mdx b/services/site/src/docs/content/build/client/index.mdx index f1b84315df60..66b05a7bffb4 100644 --- a/services/site/src/docs/content/build/client/index.mdx +++ b/services/site/src/docs/content/build/client/index.mdx @@ -1,5 +1,6 @@ --- title: "JavaScript" +description: "Connect your application to an OpenCode server with @opencode/client, the TypeScript client for the OpenCode HTTP API." --- `@opencode/client` is the TypeScript client for the OpenCode HTTP diff --git a/services/site/src/docs/content/build/index.mdx b/services/site/src/docs/content/build/index.mdx index 3f71ce51ae2d..de58c2f48b5c 100644 --- a/services/site/src/docs/content/build/index.mdx +++ b/services/site/src/docs/content/build/index.mdx @@ -1,5 +1,6 @@ --- -title: "Intro" +title: "Build on OpenCode" +description: "Build on OpenCode with plugins, the TypeScript client for its HTTP API, or the SDK that embeds it in your application." --- OpenCode is used by millions every day. Build on top of it to create your own diff --git a/services/site/src/docs/content/build/plugins/cli.mdx b/services/site/src/docs/content/build/plugins/cli.mdx index f8ba814c1ae2..ecc8b30ec68d 100644 --- a/services/site/src/docs/content/build/plugins/cli.mdx +++ b/services/site/src/docs/content/build/plugins/cli.mdx @@ -1,5 +1,5 @@ --- -title: "TUI" +title: "Building TUI plugins" description: "Build the TUI part of an OpenCode plugin for the terminal UI using @opencode/plugin/tui." --- diff --git a/services/site/src/docs/content/build/plugins/effect.mdx b/services/site/src/docs/content/build/plugins/effect.mdx index 28ae763f7230..94ea1b1b8eac 100644 --- a/services/site/src/docs/content/build/plugins/effect.mdx +++ b/services/site/src/docs/content/build/plugins/effect.mdx @@ -1,5 +1,5 @@ --- -title: "Effect" +title: "Effect plugins" description: "Write server plugins with the Effect-native plugin API." --- diff --git a/services/site/src/docs/content/build/plugins/effect/rpc.mdx b/services/site/src/docs/content/build/plugins/effect/rpc.mdx index ddadb478c6f0..1d526eb40b3c 100644 --- a/services/site/src/docs/content/build/plugins/effect/rpc.mdx +++ b/services/site/src/docs/content/build/plugins/effect/rpc.mdx @@ -1,5 +1,5 @@ --- -title: "RPC" +title: "Effect plugin RPC" description: "Expose an Effect plugin's methods and events as typed Effects and Streams." --- diff --git a/services/site/src/docs/content/build/plugins/index.mdx b/services/site/src/docs/content/build/plugins/index.mdx index e1c00d95ed2f..883d0331b7cf 100644 --- a/services/site/src/docs/content/build/plugins/index.mdx +++ b/services/site/src/docs/content/build/plugins/index.mdx @@ -1,5 +1,5 @@ --- -title: "Overview" +title: "Building plugins" description: "Build an OpenCode plugin: one package with a server part, a TUI part, a GUI part, or any combination." --- diff --git a/services/site/src/docs/content/build/plugins/rpc.mdx b/services/site/src/docs/content/build/plugins/rpc.mdx index 557508151b90..e8007382f9c1 100644 --- a/services/site/src/docs/content/build/plugins/rpc.mdx +++ b/services/site/src/docs/content/build/plugins/rpc.mdx @@ -1,5 +1,5 @@ --- -title: "RPC" +title: "Plugin RPC" description: "Expose a plugin's custom methods and events to other plugins and clients." --- diff --git a/services/site/src/docs/content/build/sdk/cloudflare.mdx b/services/site/src/docs/content/build/sdk/cloudflare.mdx index cf9dde15954f..3bc40c7c7579 100644 --- a/services/site/src/docs/content/build/sdk/cloudflare.mdx +++ b/services/site/src/docs/content/build/sdk/cloudflare.mdx @@ -1,5 +1,6 @@ --- title: "Cloudflare" +description: "Run OpenCode inside a Cloudflare Durable Object with @opencode/sdk/workerd, backed by the object's SQLite storage." --- Use `@opencode/sdk/workerd` inside a Cloudflare Durable Object. This profile uses the object's SQLite storage, diff --git a/services/site/src/docs/content/build/sdk/effect.mdx b/services/site/src/docs/content/build/sdk/effect.mdx index a7ab85e3e842..ddd84698e53c 100644 --- a/services/site/src/docs/content/build/sdk/effect.mdx +++ b/services/site/src/docs/content/build/sdk/effect.mdx @@ -1,5 +1,6 @@ --- -title: "Effect" +title: "Effect SDK" +description: "Host OpenCode in an Effect program with @opencode/sdk/effect, the Effect-native embedded SDK." --- `@opencode/sdk/effect` is the Effect-native embedded SDK. Operations return typed Effects and Streams, and closing diff --git a/services/site/src/docs/content/build/sdk/index.mdx b/services/site/src/docs/content/build/sdk/index.mdx index 36b172b5ff56..d9d7e6754ad1 100644 --- a/services/site/src/docs/content/build/sdk/index.mdx +++ b/services/site/src/docs/content/build/sdk/index.mdx @@ -1,5 +1,6 @@ --- -title: "Overview" +title: "SDK overview" +description: "Host OpenCode inside your application with @opencode/sdk, which serves the API in memory with no HTTP listener." --- `@opencode/sdk` hosts OpenCode directly inside your application. Unlike the diff --git a/services/site/src/docs/content/claude-agent.mdx b/services/site/src/docs/content/claude-agent.mdx index d8bf9e41fd4c..69de4bf1e364 100644 --- a/services/site/src/docs/content/claude-agent.mdx +++ b/services/site/src/docs/content/claude-agent.mdx @@ -1,5 +1,6 @@ --- title: "Claude Agent" +description: "Use a Claude plan or Claude Code login in OpenCode through Claude Agent, which runs Claude Code on your machine." noindex: true --- diff --git a/services/site/src/docs/content/cli/commands.mdx b/services/site/src/docs/content/cli/commands.mdx index 86ca9ad8b2f7..2b69c2a779f8 100644 --- a/services/site/src/docs/content/cli/commands.mdx +++ b/services/site/src/docs/content/cli/commands.mdx @@ -1,5 +1,5 @@ --- -title: "Commands" +title: "CLI commands" description: "Reference for the opencode command line." --- diff --git a/services/site/src/docs/content/cli/index.mdx b/services/site/src/docs/content/cli/index.mdx index b6c997d536ac..bd8150a293bb 100644 --- a/services/site/src/docs/content/cli/index.mdx +++ b/services/site/src/docs/content/cli/index.mdx @@ -1,5 +1,6 @@ --- -title: "Intro" +title: "CLI intro" +description: "Start the OpenCode terminal interface, run prompts from scripts and CI, and manage the shared background service." --- Run the CLI in a project to open the full-screen terminal interface: diff --git a/services/site/src/docs/content/cli/keybinds.mdx b/services/site/src/docs/content/cli/keybinds.mdx index 962b65c87aed..aad707674932 100644 --- a/services/site/src/docs/content/cli/keybinds.mdx +++ b/services/site/src/docs/content/cli/keybinds.mdx @@ -1,5 +1,6 @@ --- title: "Keybinds" +description: "Customize OpenCode CLI keybinds in cli.json, and look up each command's ID and default binding." --- Customize bindings in `cli.json`: diff --git a/services/site/src/docs/content/cli/plugins.mdx b/services/site/src/docs/content/cli/plugins.mdx index 765a3df2561a..91fcd61167d8 100644 --- a/services/site/src/docs/content/cli/plugins.mdx +++ b/services/site/src/docs/content/cli/plugins.mdx @@ -1,5 +1,6 @@ --- -title: "Plugins" +title: "CLI plugins" +description: "Load TUI plugins from your OpenCode config in the CLI, and add CLI-only plugins and their options in cli.json." --- Plugins configured in `opencode.json(c)` that expose a TUI component are loaded automatically by the CLI. To learn how diff --git a/services/site/src/docs/content/cli/providers.mdx b/services/site/src/docs/content/cli/providers.mdx index 400bed786c8d..1cbdf5d52254 100644 --- a/services/site/src/docs/content/cli/providers.mdx +++ b/services/site/src/docs/content/cli/providers.mdx @@ -1,5 +1,5 @@ --- -title: "Providers" +title: "CLI providers" description: "Connect provider accounts and manage credentials from the CLI and TUI." --- diff --git a/services/site/src/docs/content/cli/theme.mdx b/services/site/src/docs/content/cli/theme.mdx index 1f49ae0af1d2..da7b4c7719de 100644 --- a/services/site/src/docs/content/cli/theme.mdx +++ b/services/site/src/docs/content/cli/theme.mdx @@ -1,5 +1,6 @@ --- -title: "Theme" +title: "CLI theme" +description: "Choose a built-in theme for the OpenCode terminal interface, use your terminal's own colors, or add a theme of your own." --- OpenCode comes with many built-in themes for light and dark modes. Choose one in settings, or mix your own colors. diff --git a/services/site/src/docs/content/commands.mdx b/services/site/src/docs/content/commands.mdx index 228618530696..b5f5784e091f 100644 --- a/services/site/src/docs/content/commands.mdx +++ b/services/site/src/docs/content/commands.mdx @@ -1,5 +1,6 @@ --- title: "Commands" +description: "Turn prompts into reusable slash commands in Markdown or JSON, with arguments, shell output, and attachments." --- Create `.opencode/commands/review.md` to turn a prompt into `/review`: diff --git a/services/site/src/docs/content/compaction.mdx b/services/site/src/docs/content/compaction.mdx index 4f73e220780b..e07fa41a21e1 100644 --- a/services/site/src/docs/content/compaction.mdx +++ b/services/site/src/docs/content/compaction.mdx @@ -1,5 +1,6 @@ --- title: "Compaction" +description: "Compaction summarizes older conversation, automatically or on request, so an OpenCode session can keep going past the model's context limit." --- Compaction makes room in a long session by replacing older conversation with a diff --git a/services/site/src/docs/content/config.mdx b/services/site/src/docs/content/config.mdx index 3a6cf47e5475..624cd74c8d24 100644 --- a/services/site/src/docs/content/config.mdx +++ b/services/site/src/docs/content/config.mdx @@ -1,5 +1,6 @@ --- title: "Config" +description: "Configure OpenCode in opencode.json or opencode.jsonc, and see where config files live, how they take precedence, and how to substitute variables." --- Create `opencode.jsonc` in your project to configure OpenCode. Add the schema for editor validation, then set only the options you need. diff --git a/services/site/src/docs/content/console/index.mdx b/services/site/src/docs/content/console/index.mdx index 28f10545eb75..a62f5ec66fcb 100644 --- a/services/site/src/docs/content/console/index.mdx +++ b/services/site/src/docs/content/console/index.mdx @@ -1,5 +1,6 @@ --- -title: "Intro" +title: "Console intro" +description: "OpenCode Console is an optional service that adds team workspaces, model inference, budgets, policies, and hosted web search." --- The [OpenCode Console](https://opencode.ai/console) is an optional service that provides additional benefits to diff --git a/services/site/src/docs/content/console/models.mdx b/services/site/src/docs/content/console/models.mdx index 1a4c3d3fdfad..4d8d4349202a 100644 --- a/services/site/src/docs/content/console/models.mdx +++ b/services/site/src/docs/content/console/models.mdx @@ -1,5 +1,5 @@ --- -title: "Models" +title: "Console models" description: "Curated coding models, pay-as-you-go pricing, and API access through OpenCode Console." --- diff --git a/services/site/src/docs/content/console/providers.mdx b/services/site/src/docs/content/console/providers.mdx index 7472a68487fa..51d961e6ec44 100644 --- a/services/site/src/docs/content/console/providers.mdx +++ b/services/site/src/docs/content/console/providers.mdx @@ -1,5 +1,5 @@ --- -title: "Providers" +title: "Console providers" description: "Connect your own model provider accounts to an OpenCode Console workspace and choose which models members can use." --- diff --git a/services/site/src/docs/content/console/websearch.mdx b/services/site/src/docs/content/console/websearch.mdx index 229b5351d910..9ef75afb1efc 100644 --- a/services/site/src/docs/content/console/websearch.mdx +++ b/services/site/src/docs/content/console/websearch.mdx @@ -1,5 +1,5 @@ --- -title: "Web search" +title: "Console web search" description: "Hosted web search for OpenCode through Console." --- diff --git a/services/site/src/docs/content/formatters.mdx b/services/site/src/docs/content/formatters.mdx index 0b9c1a9ec3dc..dc5c532fba79 100644 --- a/services/site/src/docs/content/formatters.mdx +++ b/services/site/src/docs/content/formatters.mdx @@ -1,5 +1,6 @@ --- title: "Formatters" +description: "Format files after OpenCode edits them, with built-in formatters such as Prettier, Biome, gofmt, and Ruff, or your own commands." --- OpenCode can format files after its `write`, `edit`, or `patch` tools change diff --git a/services/site/src/docs/content/index.mdx b/services/site/src/docs/content/index.mdx index 6c349199e3cb..5d23b3cc6800 100644 --- a/services/site/src/docs/content/index.mdx +++ b/services/site/src/docs/content/index.mdx @@ -1,5 +1,6 @@ --- title: "Intro" +description: "Install OpenCode, the open source coding agent, as a CLI, desktop app, web app, or Docker image, then connect a model provider." --- OpenCode is an open source coding agent. It’s available as a terminal-based interface, desktop app, or web app. diff --git a/services/site/src/docs/content/instructions.mdx b/services/site/src/docs/content/instructions.mdx index cecc9447875c..b2345af5bfd0 100644 --- a/services/site/src/docs/content/instructions.mdx +++ b/services/site/src/docs/content/instructions.mdx @@ -1,5 +1,6 @@ --- title: "Instructions" +description: "Give OpenCode persistent project guidance with AGENTS.md files, and see where they apply, the order they load in, and how the CLAUDE.md fallback works." --- Add an `AGENTS.md` file to give OpenCode persistent project guidance. Use it for build commands, architecture notes, code conventions, and verification requirements. diff --git a/services/site/src/docs/content/mcp-servers.mdx b/services/site/src/docs/content/mcp-servers.mdx index 21f1074003a7..bdfa3ab5254a 100644 --- a/services/site/src/docs/content/mcp-servers.mdx +++ b/services/site/src/docs/content/mcp-servers.mdx @@ -1,5 +1,6 @@ --- title: "MCP servers" +description: "Connect OpenCode to local and remote Model Context Protocol servers with opencode mcp add or in config, including OAuth sign-in." --- OpenCode connects to [Model Context Protocol](https://modelcontextprotocol.io/) servers and exposes capabilities such as tools, prompts, resources, and instructions. MCP tools consume model context, so add only the servers you need. diff --git a/services/site/src/docs/content/migrate-v1.mdx b/services/site/src/docs/content/migrate-v1.mdx index 5eac2dd9a087..84c15373b168 100644 --- a/services/site/src/docs/content/migrate-v1.mdx +++ b/services/site/src/docs/content/migrate-v1.mdx @@ -1,5 +1,6 @@ --- title: "Migrate from V1" +description: "Upgrade from OpenCode 1 to OpenCode 2, which has breaking changes to plugins, the server API, and terminal client configuration." --- OpenCode 1 and OpenCode 2 both use the `opencode` command and are no longer installed side by side by default. Remove a diff --git a/services/site/src/docs/content/models.mdx b/services/site/src/docs/content/models.mdx index 73f21d027e3b..b6a1b7408cf6 100644 --- a/services/site/src/docs/content/models.mdx +++ b/services/site/src/docs/content/models.mdx @@ -1,5 +1,6 @@ --- title: "Models" +description: "Choose a model per session or run, set a default, and configure variants, reasoning, prompt caching, and local models." --- Choose a model for the current session with `/models`: diff --git a/services/site/src/docs/content/permissions.mdx b/services/site/src/docs/content/permissions.mdx index fb09c3da8ce8..99adcfe94714 100644 --- a/services/site/src/docs/content/permissions.mdx +++ b/services/site/src/docs/content/permissions.mdx @@ -1,5 +1,6 @@ --- title: "Permissions" +description: "Control what OpenCode agents can do with ordered allow, deny, and ask rules that match actions and resources such as paths and commands." --- Permissions control whether an agent may perform an action on a resource. diff --git a/services/site/src/docs/content/plugins.mdx b/services/site/src/docs/content/plugins.mdx index 2c3a2771aaab..60f2f651ad45 100644 --- a/services/site/src/docs/content/plugins.mdx +++ b/services/site/src/docs/content/plugins.mdx @@ -1,5 +1,6 @@ --- title: "Plugins" +description: "Add npm packages or local plugin directories to OpenCode in opencode.json, and enable or disable plugins by ID or wildcard." --- Add published packages, versioned packages, scoped packages, or local plugin directories to `opencode.json(c)`. diff --git a/services/site/src/docs/content/providers.mdx b/services/site/src/docs/content/providers.mdx index 0d93bcb15b15..c6cb1d4f3de0 100644 --- a/services/site/src/docs/content/providers.mdx +++ b/services/site/src/docs/content/providers.mdx @@ -1,5 +1,6 @@ --- title: "Providers" +description: "Connect OpenCode to model providers such as OpenCode Go, ChatGPT, Amazon Bedrock, Google Vertex, GitHub Copilot, and Ollama, or add a custom one." --- OpenCode includes a provider and model catalog from [models.dev](https://models.dev). For most providers, connect an diff --git a/services/site/src/docs/content/references.mdx b/services/site/src/docs/content/references.mdx index 947616ff7754..c37bbe5bb990 100644 --- a/services/site/src/docs/content/references.mdx +++ b/services/site/src/docs/content/references.mdx @@ -1,5 +1,6 @@ --- title: "References" +description: "Give OpenCode named access to local directories and Git repositories outside the current project, then attach them to prompts." --- References give OpenCode named access to directories outside the current diff --git a/services/site/src/docs/content/skills.mdx b/services/site/src/docs/content/skills.mdx index 7936cb432a3d..2e443721e40d 100644 --- a/services/site/src/docs/content/skills.mdx +++ b/services/site/src/docs/content/skills.mdx @@ -1,5 +1,6 @@ --- title: "Skills" +description: "Write SKILL.md files that give OpenCode agents reusable instructions for a task, loaded only when the task needs them." --- Create a skill to give an agent reusable instructions for a specific task. Put a `SKILL.md` file in `.opencode/skills/` and describe when to use it in `description`. diff --git a/services/site/src/docs/content/snapshots.mdx b/services/site/src/docs/content/snapshots.mdx index 88bca613bcb7..e8f67bbf2b7f 100644 --- a/services/site/src/docs/content/snapshots.mdx +++ b/services/site/src/docs/content/snapshots.mdx @@ -1,5 +1,6 @@ --- title: "Snapshots" +description: "Undo and redo recent conversation and file changes with /undo and /redo, and see which files snapshots capture." --- Snapshots let you undo recent conversation and file changes together. Use them to revise recent work, but keep Git commits diff --git a/services/site/src/docs/content/themes.mdx b/services/site/src/docs/content/themes.mdx index 35f91656b052..c45a5f3de049 100644 --- a/services/site/src/docs/content/themes.mdx +++ b/services/site/src/docs/content/themes.mdx @@ -1,5 +1,6 @@ --- title: "Themes" +description: "Create custom OpenCode terminal themes as JSON files, with light and dark modes, hues, state colors, and tokens." --- Choose a theme from the terminal UI by pressing `Ctrl+P`, selecting **Open settings**, and opening **Theme**. You can also diff --git a/services/site/src/docs/content/tools.mdx b/services/site/src/docs/content/tools.mdx index 6f7dac76f35b..a40e088456c0 100644 --- a/services/site/src/docs/content/tools.mdx +++ b/services/site/src/docs/content/tools.mdx @@ -1,5 +1,6 @@ --- title: "Tools" +description: "OpenCode's built-in tools read and edit files, run shell commands, fetch and search the web, start subagents, and drive a browser." --- Ask for the outcome you want. OpenCode chooses the available tools, requests diff --git a/services/site/src/docs/content/troubleshooting.mdx b/services/site/src/docs/content/troubleshooting.mdx index 23587497955e..01f67d7ceb10 100644 --- a/services/site/src/docs/content/troubleshooting.mdx +++ b/services/site/src/docs/content/troubleshooting.mdx @@ -1,5 +1,6 @@ --- title: "Troubleshooting" +description: "Diagnose OpenCode problems by checking the background service, inspecting the API, reading logs, and capturing profiles." --- diff --git a/services/site/src/docs/content/warming.mdx b/services/site/src/docs/content/warming.mdx index 4c39f74383c7..a5a7dbd5f0d4 100644 --- a/services/site/src/docs/content/warming.mdx +++ b/services/site/src/docs/content/warming.mdx @@ -1,5 +1,6 @@ --- title: "Warming" +description: "Send periodic requests that keep a session's provider prompt cache from expiring while you pause between prompts." --- Session warming sends periodic model requests to preserve provider-side prompt diff --git a/services/site/src/docs/content/websearch.mdx b/services/site/src/docs/content/websearch.mdx index c03848e33654..f73a82645b6f 100644 --- a/services/site/src/docs/content/websearch.mdx +++ b/services/site/src/docs/content/websearch.mdx @@ -1,5 +1,6 @@ --- title: "Web search" +description: "Let OpenCode search the web with Exa, Firecrawl, Parallel, Tavily, or TinyFish, and choose the provider and permissions for searches." --- Ask OpenCode for current information and it can search the web, read the results, and include source links in its response.