opencode-map

▸ guides/

Guides

Practical walkthroughs — from the first session to publishing your own plugin.

##Beginner

  1. 01

    Getting started with opencode

    Install opencode, connect a model provider, initialize a project with /init, and learn the plan/build workflow with undo and redo.

    Last updated: Oct 21, 2026

  2. 02

    Providers and models in opencode

    Connect providers with /connect, use OpenCode Zen, set model and small_model in opencode.json, switch models with /models, and add custom OpenAI-compatible providers.

    Last updated: Oct 21, 2026

##Intermediate

  1. 01

    Configuring opencode: opencode.json in depth

    How opencode.json/jsonc works: file locations and merge precedence, the schema, model/provider keys, agents, MCP, plugins, and the separate tui.json.

    Last updated: Oct 21, 2026

  2. 02

    Agents in opencode: build, plan, and custom subagents

    Use opencode's built-in build/plan primary agents and general/explore/scout subagents, invoke them with Tab and @-mentions, and define custom agents in Markdown or opencode.json.

    Last updated: Oct 21, 2026

  3. 03

    Adding MCP servers to opencode

    Configure local and remote MCP servers in opencode.json: command and url forms, env interpolation, OAuth, the opencode mcp CLI, and per-agent tool control.

    Last updated: Oct 21, 2026

  4. 04

    Permissions in opencode: allow, ask, deny

    Control which actions opencode runs automatically: the permission config, allow/ask/deny actions, wildcards and shell command patterns, external_directory, doom_loop, and per-agent overrides.

    Last updated: Oct 21, 2026

  5. 05

    Custom commands and keybinds in opencode

    Define custom slash commands in .opencode/commands or opencode.json — arguments, shell injection, file refs — and remap TUI keybinds in tui.json, including the leader key.

    Last updated: Oct 21, 2026

  6. 06

    OpenCode v1 to v2: what moved where

    A field-by-field mapping from OpenCode 1 config to OpenCode 2 — renamed keys, moved surfaces, removed features, and v2-only additions, based on the official migration doc.

    Last updated: Oct 21, 2026

##Advanced

  1. 01

    Writing an opencode plugin

    Build a plugin for opencode: where plugins live, the module/hooks shape, the context object, npm dependencies via bun install, TypeScript types, and publishing.

    Last updated: Oct 21, 2026