> opencode

the open-source terminal coding agent — bring any of 75+ providers, share sessions by URL, script it with opencode run, and switch between build and plan agents

getting started sessions & tui headless & scripting keyboard shortcuts configuration models & providers agents & rules mcp & integrations

// getting started

5 commands

Install opencode on macOS, Linux, or Windows

$ curl -fsSL https://opencode.ai/install | bash

Start opencode in your project

Authenticate a model provider

$ opencode auth login

Generate a project guide with /init

Keep opencode up to date

$ opencode upgrade

// sessions & tui

6 commands

Start a new session

List and switch between sessions

Compact a long conversation to free context

Undo and redo the agent's changes

Share a session as a public link

Reference files and run shell commands inside a prompt

$ @src/api.ts

// headless & scripting

6 commands

Run a one-off prompt without the TUI

$ opencode run "explain how the auth module works"

Continue or fork a session from the command line

$ opencode run -c "now add tests for that change"

Pipe input or attach files to a headless run

$ cat error.log | opencode run "explain this error and suggest a fix"

Get machine-readable JSON output

$ opencode run "list every TODO in the codebase" --format json

Pick the model or agent for a single run

$ opencode run -m anthropic/claude-sonnet-4-5 "refactor this function"

Run opencode as a server and attach to it

$ opencode serve --port 4096

// keyboard shortcuts

5 commands

Open the command palette

Cycle between the Build and Plan agents

Switch or cycle the model

Interrupt the agent mid-response

Add a newline without sending the prompt

// configuration

5 commands

Configure opencode with opencode.json

$ ~/.config/opencode/opencode.json

Control which tools need approval

$ { "permission": { "edit": "ask", "bash": "ask" } }

Inject secrets and env values into config

$ { "model": "{env:OPENCODE_MODEL}" }

Configure opencode with environment variables

$ export OPENCODE_MODEL=anthropic/claude-sonnet-4-5

Change the TUI theme

// models & providers

4 commands

Switch the model mid-session

List every model available to you

$ opencode models

Use a cheaper model for small tasks

$ { "small_model": "anthropic/claude-haiku-4-5" }

Use opencode Zen for managed, coding-tuned models

// agents & rules

4 commands

Switch between the Build and Plan agents

$ { "default_agent": "plan" }

Hand a focused task to a subagent

$ @general research how sessions are persisted

Create a custom agent

$ opencode agent create

Give opencode project rules with AGENTS.md

$ ./AGENTS.md

// mcp & integrations

5 commands

Add a local MCP server

$ ~/.config/opencode/opencode.json

Add a remote MCP server

$ { "mcp": { "my-remote": { "type": "remote", "url": "https://mcp.example.com", "enabled": true, "headers": { "Authorization": "Bearer {env:MCP_TOKEN}" } } } }

Run opencode on GitHub issues and PRs

$ opencode github install

Enable LSP for better code awareness

$ { "lsp": true }

Set the editor opencode opens for prompts

$ export EDITOR=nvim