Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions services/site/src/docs/content/agents.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/attachments.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/build/client/effect.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/build/client/index.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/build/index.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/build/plugins/cli.mdx
Original file line number Diff line number Diff line change
@@ -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."
---

Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/build/plugins/effect.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Effect"
title: "Effect plugins"
description: "Write server plugins with the Effect-native plugin API."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "RPC"
title: "Effect plugin RPC"
description: "Expose an Effect plugin's methods and events as typed Effects and Streams."
---

Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/build/plugins/index.mdx
Original file line number Diff line number Diff line change
@@ -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."
---

Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/build/plugins/rpc.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "RPC"
title: "Plugin RPC"
description: "Expose a plugin's custom methods and events to other plugins and clients."
---

Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/build/sdk/cloudflare.mdx
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/build/sdk/effect.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/build/sdk/index.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/claude-agent.mdx
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/cli/commands.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Commands"
title: "CLI commands"
description: "Reference for the opencode command line."
---

Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/cli/index.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/cli/keybinds.mdx
Original file line number Diff line number Diff line change
@@ -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`:
Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/cli/plugins.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/cli/providers.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Providers"
title: "CLI providers"
description: "Connect provider accounts and manage credentials from the CLI and TUI."
---

Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/cli/theme.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/commands.mdx
Original file line number Diff line number Diff line change
@@ -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`:
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/compaction.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/config.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 2 additions & 1 deletion services/site/src/docs/content/console/index.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/console/models.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Models"
title: "Console models"
description: "Curated coding models, pay-as-you-go pricing, and API access through OpenCode Console."
---

Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/console/providers.mdx
Original file line number Diff line number Diff line change
@@ -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."
---

Expand Down
2 changes: 1 addition & 1 deletion services/site/src/docs/content/console/websearch.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Web search"
title: "Console web search"
description: "Hosted web search for OpenCode through Console."
---

Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/formatters.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/instructions.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/mcp-servers.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/migrate-v1.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/models.mdx
Original file line number Diff line number Diff line change
@@ -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`:
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/permissions.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/plugins.mdx
Original file line number Diff line number Diff line change
@@ -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)`.
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/providers.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/references.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/skills.mdx
Original file line number Diff line number Diff line change
@@ -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/<skill-id>` and describe when to use it in `description`.
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/snapshots.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/themes.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/tools.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Troubleshooting"
description: "Diagnose OpenCode problems by checking the background service, inspecting the API, reading logs, and capturing profiles."
---

<Callout type="tip">
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/warming.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions services/site/src/docs/content/websearch.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading