CLI - Opencode — ContextQMD

import { Tabs, TabItem } from "@astrojs/starlight/components"

The OpenCode CLI by default starts the TUI when run without any arguments.

bash

opencode

But it also accepts commands as documented on this page. This allows you to interact with OpenCode programmatically.

bash

opencode run "Explain how closures work in JavaScript"

tui

Start the OpenCode terminal user interface.

bash

opencode [project]

Flags

Flag	Short	Description
<nobr><code>{"--continue"}</code></nobr>	`-c`	Continue the last session
<nobr><code>{"--session"}</code></nobr>	`-s`	Session ID to continue
<nobr><code>{"--fork"}</code></nobr>		Fork the session when continuing (use with `--continue` or `--session`)
<nobr><code>{"--prompt"}</code></nobr>		Prompt to use
<nobr><code>{"--model"}</code></nobr>	`-m`	Model to use in the form of provider/model
<nobr><code>{"--agent"}</code></nobr>		Agent to use
<nobr><code>{"--port"}</code></nobr>		Port to listen on
<nobr><code>{"--hostname"}</code></nobr>		Hostname to listen on
<nobr><code>{"--mdns"}</code></nobr>		Enable mDNS discovery
<nobr><code>{"--mdns-domain"}</code></nobr>		Custom mDNS domain name
<nobr><code>{"--cors"}</code></nobr>		Additional browser origin(s) to allow CORS

Commands

The OpenCode CLI also has the following commands.

agent

Manage agents for OpenCode.

bash

opencode agent [command]

attach

Attach a terminal to an already running OpenCode backend server started via serve or web commands.

bash

opencode attach [url]

This allows using the TUI with a remote OpenCode backend. For example:

bash

# Start the backend server for web/mobile access
opencode web --port 4096 --hostname 0.0.0.0

# In another terminal, attach the TUI to the running backend
opencode attach http://10.20.30.40:4096

Flags

Flag	Short	Description
<nobr><code>{"--dir"}</code></nobr>		Working directory to start TUI in
<nobr><code>{"--continue"}</code></nobr>	`-c`	Continue the last session
<nobr><code>{"--session"}</code></nobr>	`-s`	Session ID to continue
<nobr><code>{"--fork"}</code></nobr>		Fork the session when continuing (use with `--continue` or `--session`)
<nobr><code>{"--password"}</code></nobr>	`-p`	Basic auth password (defaults to `OPENCODE_SERVER_PASSWORD`)
<nobr><code>{"--username"}</code></nobr>	`-u`	Basic auth username (defaults to `OPENCODE_SERVER_USERNAME` or `opencode`)

create

Create a new agent with custom configuration.

bash

opencode agent create

This command will guide you through creating a new agent with a custom system prompt and permission configuration. Anything you don't allow is denied in the generated agent's frontmatter.

Flags

Flag	Short	Description
<nobr><code>{"--path"}</code></nobr>		Directory to write the agent file to (defaults to global or `.opencode/agent` based on the prompt)
<nobr><code>{"--description"}</code></nobr>		What the agent should do
<nobr><code>{"--mode"}</code></nobr>		Agent mode: `all`, `primary`, or `subagent`
<nobr><code>{"--permissions"}</code></nobr>		Comma-separated list of permissions to allow (default: all). Available: `bash`, `read`, `edit`, `glob`, `grep`, `webfetch`, `task`, `todowrite`, `websearch`, `lsp`, `skill`. Anything omitted is denied. Alias: `--tools`
<nobr><code>{"--model"}</code></nobr>	`-m`	Model to use, in `provider/model` format

Passing all of --path, --description, --mode, and --permissions runs the command non-interactively.

list

List all available agents.

bash

opencode agent list

auth

Command to manage credentials and login for providers.

bash

opencode auth [command]

login

OpenCode is powered by the provider list at Models.dev, so you can use opencode auth login to configure API keys for any provider you'd like to use. This is stored in ~/.local/share/opencode/auth.json.

bash

opencode auth login

When OpenCode starts up it loads the providers from the credentials file. And if there are any keys defined in your environments or a .env file in your project.

Flags

Flag	Short	Description
<nobr><code>{"--provider"}</code></nobr>	`-p`	Provider ID or name to log in to
<nobr><code>{"--method"}</code></nobr>	`-m`	Login method label to use, skipping method selection

list

Lists all the authenticated providers as stored in the credentials file.

bash

opencode auth list

Or the short version.

bash

opencode auth ls

logout

Logs you out of a provider by clearing it from the credentials file.

bash

opencode auth logout

github

Manage the GitHub agent for repository automation.

bash

opencode github [command]

install

Install the GitHub agent in your repository.

bash

opencode github install

This sets up the necessary GitHub Actions workflow and guides you through the configuration process. Learn more.

run

Run the GitHub agent. This is typically used in GitHub Actions.

bash

opencode github run

Flags

Flag	Description
<nobr><code>{"--event"}</code></nobr>	GitHub mock event to run the agent for
<nobr><code>{"--token"}</code></nobr>	GitHub personal access token

mcp

Manage Model Context Protocol servers.

bash

opencode mcp [command]

add

Add an MCP server to your configuration.

bash

opencode mcp add

This command will guide you through adding either a local or remote MCP server.

list

List all configured MCP servers and their connection status.

bash

opencode mcp list

Or use the short version.

bash

opencode mcp ls

auth

Authenticate with an OAuth-enabled MCP server.

bash

opencode mcp auth [name]

If you don't provide a server name, you'll be prompted to select from available OAuth-capable servers.

You can also list OAuth-capable servers and their authentication status.

bash

opencode mcp auth list

Or use the short version.

bash

opencode mcp auth ls

logout

Remove OAuth credentials for an MCP server.

bash

opencode mcp logout [name]

debug

Debug OAuth connection issues for an MCP server.

bash

opencode mcp debug <name>

models

List all available models from configured providers.

bash

opencode models [provider]

This command displays all models available across your configured providers in the format provider/model.

This is useful for figuring out the exact model name to use in your config.

You can optionally pass a provider ID to filter models by that provider.

bash

opencode models anthropic

Flags

Flag	Description
<nobr><code>{"--refresh"}</code></nobr>	Refresh the models cache from models.dev
<nobr><code>{"--verbose"}</code></nobr>	Use more verbose model output (includes metadata like costs)

Use the --refresh flag to update the cached model list. This is useful when new models have been added to a provider and you want to see them in OpenCode.

bash

opencode models --refresh

run

Run opencode in non-interactive mode by passing a prompt directly.

bash

opencode run [message..]

This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.

bash

opencode run Explain the use of context in Go

You can also attach to a running opencode serve instance to avoid MCP server cold boot times on every run:

bash

# Start a headless server in one terminal
opencode serve

# In another terminal, run commands that attach to it
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"

Flags

Flag	Short	Description
<nobr><code>{"--command"}</code></nobr>		The command to run, use message for args
<nobr><code>{"--continue"}</code></nobr>	`-c`	Continue the last session
<nobr><code>{"--session"}</code></nobr>	`-s`	Session ID to continue
<nobr><code>{"--fork"}</code></nobr>		Fork the session when continuing (use with `--continue` or `--session`)
<nobr><code>{"--share"}</code></nobr>		Share the session
<nobr><code>{"--model"}</code></nobr>	`-m`	Model to use in the form of provider/model
<nobr><code>{"--agent"}</code></nobr>		Agent to use
<nobr><code>{"--file"}</code></nobr>	`-f`	File(s) to attach to message
<nobr><code>{"--format"}</code></nobr>		Format: default (formatted) or json (raw JSON events)
<nobr><code>{"--title"}</code></nobr>		Title for the session (uses truncated prompt if no value provided)
<nobr><code>{"--attach"}</code></nobr>		Attach to a running opencode server (e.g., http://localhost:4096)
<nobr><code>{"--password"}</code></nobr>	`-p`	Basic auth password (defaults to `OPENCODE_SERVER_PASSWORD`)
<nobr><code>{"--username"}</code></nobr>	`-u`	Basic auth username (defaults to `OPENCODE_SERVER_USERNAME` or `opencode`)
<nobr><code>{"--dir"}</code></nobr>		Directory to run in, or path on the remote server when attaching
<nobr><code>{"--port"}</code></nobr>		Port for the local server (defaults to random port)
<nobr><code>{"--variant"}</code></nobr>		Model variant (provider-specific reasoning effort)
<nobr><code>{"--thinking"}</code></nobr>		Show thinking blocks
<nobr><code>{"--dangerously-skip-permissions"}</code></nobr>		Auto-approve permissions that are not explicitly denied (dangerous!)

serve

Start a headless OpenCode server for API access. Check out the server docs for the full HTTP interface.

bash

opencode serve

This starts an HTTP server that provides API access to opencode functionality without the TUI interface. Set OPENCODE_SERVER_PASSWORD to enable HTTP basic auth (username defaults to opencode).

Flags

Flag	Description
<nobr><code>{"--port"}</code></nobr>	Port to listen on
<nobr><code>{"--hostname"}</code></nobr>	Hostname to listen on
<nobr><code>{"--mdns"}</code></nobr>	Enable mDNS discovery
<nobr><code>{"--mdns-domain"}</code></nobr>	Custom mDNS domain name
<nobr><code>{"--cors"}</code></nobr>	Additional browser origin(s) to allow CORS

session

Manage OpenCode sessions.

bash

opencode session [command]

list

List all OpenCode sessions.

bash

opencode session list

Flags

Flag	Short	Description
<nobr><code>{"--max-count"}</code></nobr>	`-n`	Limit to N most recent sessions
<nobr><code>{"--format"}</code></nobr>		Output format: table or json (table)

delete

Delete an OpenCode session.

bash

opencode session delete <sessionID>

stats

Show token usage and cost statistics for your OpenCode sessions.

bash

opencode stats

Flags

Flag	Description
<nobr><code>{"--days"}</code></nobr>	Show stats for the last N days (all time)
<nobr><code>{"--tools"}</code></nobr>	Number of tools to show (all)
<nobr><code>{"--models"}</code></nobr>	Show model usage breakdown (hidden by default). Pass a number to show top N
<nobr><code>{"--project"}</code></nobr>	Filter by project (all projects, empty string: current project)

export

Export session data as JSON.

bash

opencode export [sessionID]

If you don't provide a session ID, you'll be prompted to select from available sessions.

Flags

Flag	Description
<nobr><code>{"--sanitize"}</code></nobr>	Redact sensitive transcript/file data

import

Import session data from a JSON file or OpenCode share URL.

bash

opencode import <file>

You can import from a local file or an OpenCode share URL.

bash

opencode import session.json
opencode import https://opncd.ai/s/abc123

web

Start a headless OpenCode server with a web interface.

bash

opencode web

This starts an HTTP server and opens a web browser to access OpenCode through a web interface. Set OPENCODE_SERVER_PASSWORD to enable HTTP basic auth (username defaults to opencode).

Flags

Flag	Description
<nobr><code>{"--port"}</code></nobr>	Port to listen on
<nobr><code>{"--hostname"}</code></nobr>	Hostname to listen on
<nobr><code>{"--mdns"}</code></nobr>	Enable mDNS discovery
<nobr><code>{"--mdns-domain"}</code></nobr>	Custom mDNS domain name
<nobr><code>{"--cors"}</code></nobr>	Additional browser origin(s) to allow CORS

acp

Start an ACP (Agent Client Protocol) server.

bash

opencode acp

This command starts an ACP server that communicates via stdin/stdout using nd-JSON.

Flags

Flag	Description
<nobr><code>{"--cwd"}</code></nobr>	Working directory
<nobr><code>{"--port"}</code></nobr>	Port to listen on
<nobr><code>{"--hostname"}</code></nobr>	Hostname to listen on
<nobr><code>{"--mdns"}</code></nobr>	Enable mDNS discovery
<nobr><code>{"--mdns-domain"}</code></nobr>	Custom mDNS domain name
<nobr><code>{"--cors"}</code></nobr>	Additional browser origin(s) to allow CORS

plugin

Install a plugin and update your config.

bash

opencode plugin <module>

Or use the alias.

bash

opencode plug <module>

Flags

Flag	Short	Description
<nobr><code>{"--global"}</code></nobr>	`-g`	Install in global config
<nobr><code>{"--force"}</code></nobr>	`-f`	Replace existing plugin version

pr

Fetch and checkout a GitHub PR branch, then run OpenCode.

bash

opencode pr <number>

db

Database tools.

bash

opencode db [query]

Flags

Flag	Description
<nobr><code>{"--format"}</code></nobr>	Output format: `json` or `tsv`

path

Print the database path.

bash

opencode db path

debug

Debugging and troubleshooting tools.

bash

opencode debug [command]

uninstall

Uninstall OpenCode and remove all related files.

bash

opencode uninstall

Flags

Flag	Short	Description
<nobr><code>{"--keep-config"}</code></nobr>	`-c`	Keep configuration files
<nobr><code>{"--keep-data"}</code></nobr>	`-d`	Keep session data and snapshots
<nobr><code>{"--dry-run"}</code></nobr>		Show what would be removed without removing
<nobr><code>{"--force"}</code></nobr>	`-f`	Skip confirmation prompts

upgrade

Updates opencode to the latest version or a specific version.

bash

opencode upgrade [target]

To upgrade to the latest version.

bash

opencode upgrade

To upgrade to a specific version.

bash

opencode upgrade v0.1.48

Flags

Flag	Short	Description
<nobr><code>{"--method"}</code></nobr>	`-m`	The installation method that was used; curl, npm, pnpm, bun, brew

Global Flags

The opencode CLI takes the following global flags.

Flag	Short	Description
<nobr><code>{"--help"}</code></nobr>	`-h`	Display help
<nobr><code>{"--version"}</code></nobr>	`-v`	Print version number
<nobr><code>{"--print-logs"}</code></nobr>		Print logs to stderr
<nobr><code>{"--log-level"}</code></nobr>		Log level (DEBUG, INFO, WARN, ERROR)
<nobr><code>{"--pure"}</code></nobr>		Run without external plugins

Environment variables

OpenCode can be configured using environment variables.

Variable	Type	Description
`OPENCODE_AUTO_SHARE`	boolean	Automatically share sessions
`OPENCODE_GIT_BASH_PATH`	string	Path to Git Bash executable on Windows
`OPENCODE_CONFIG`	string	Path to config file
`OPENCODE_TUI_CONFIG`	string	Path to TUI config file
`OPENCODE_CONFIG_DIR`	string	Path to config directory
`OPENCODE_CONFIG_CONTENT`	string	Inline json config content
`OPENCODE_DISABLE_AUTOUPDATE`	boolean	Disable automatic update checks
`OPENCODE_DISABLE_PRUNE`	boolean	Disable pruning of old data
`OPENCODE_DISABLE_TERMINAL_TITLE`	boolean	Disable automatic terminal title updates
`OPENCODE_PERMISSION`	string	Inlined json permissions config
`OPENCODE_DISABLE_DEFAULT_PLUGINS`	boolean	Disable default plugins
`OPENCODE_DISABLE_LSP_DOWNLOAD`	boolean	Disable automatic LSP server downloads
`OPENCODE_ENABLE_EXPERIMENTAL_MODELS`	boolean	Enable experimental models
`OPENCODE_DISABLE_AUTOCOMPACT`	boolean	Disable automatic context compaction
`OPENCODE_DISABLE_CLAUDE_CODE`	boolean	Disable reading from `.claude` (prompt + skills)
`OPENCODE_DISABLE_CLAUDE_CODE_PROMPT`	boolean	Disable reading `~/.claude/CLAUDE.md`
`OPENCODE_DISABLE_CLAUDE_CODE_SKILLS`	boolean	Disable loading `.claude/skills`
`OPENCODE_DISABLE_MODELS_FETCH`	boolean	Disable fetching models from remote sources
`OPENCODE_DISABLE_MOUSE`	boolean	Disable mouse capture in the TUI
`OPENCODE_FAKE_VCS`	string	Fake VCS provider for testing purposes
`OPENCODE_CLIENT`	string	Client identifier (defaults to `cli`)
`OPENCODE_ENABLE_EXA`	boolean	Enable Exa web search tools
`OPENCODE_SERVER_PASSWORD`	string	Enable basic auth for `serve`/`web`
`OPENCODE_SERVER_USERNAME`	string	Override basic auth username (default `opencode`)
`OPENCODE_MODELS_URL`	string	Custom URL for fetching models configuration

Experimental

These environment variables enable experimental features that may change or be removed.

Variable	Type	Description
`OPENCODE_EXPERIMENTAL`	boolean	Enable all experimental features
`OPENCODE_EXPERIMENTAL_ICON_DISCOVERY`	boolean	Enable icon discovery
`OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT`	boolean	Disable copy on select in TUI
`OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS`	number	Default timeout for bash commands in ms
`OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX`	number	Max output tokens for LLM responses
`OPENCODE_EXPERIMENTAL_FILEWATCHER`	boolean	Enable file watcher for entire dir
`OPENCODE_EXPERIMENTAL_OXFMT`	boolean	Enable oxfmt formatter
`OPENCODE_EXPERIMENTAL_LSP_TOOL`	boolean	Enable experimental LSP tool
`OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER`	boolean	Disable file watcher
`OPENCODE_EXPERIMENTAL_EXA`	boolean	Enable experimental Exa features
`OPENCODE_EXPERIMENTAL_LSP_TY`	boolean	Enable TY LSP for python files
`OPENCODE_EXPERIMENTAL_MARKDOWN`	boolean	Enable experimental markdown features
`OPENCODE_EXPERIMENTAL_PLAN_MODE`	boolean	Enable plan mode