OpenCode commands and subcommands

Starts the OpenCode terminal user interface (TUI), optionally for a given project directory; this is the default when run with no arguments.

Manage agents for OpenCode.

Creates a new agent with a custom system prompt and permission configuration; anything not allowed is denied in the generated agent frontmatter. Passing all of --path, --description, --mode and --permissions runs it non-interactively.

Lists all available agents.

Attaches a terminal TUI to an already running OpenCode backend server started via serve or web.

Manages credentials and login for providers.

Configures API keys for any provider from Models.dev; credentials are stored in ~/.local/share/opencode/auth.json.

Lists all authenticated providers stored in the credentials file. Alias: auth ls.

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

Manages the GitHub agent for repository automation.

Installs the GitHub agent in a repository, setting up the GitHub Actions workflow and guiding configuration.

Runs the GitHub agent; typically used in GitHub Actions.

Manages Model Context Protocol servers.

Interactively adds a local or remote MCP server to the configuration.

Lists configured MCP servers and their connection status. Alias: mcp ls.

Authenticates with an OAuth-enabled MCP server; prompts for a server if no name is given. mcp auth list (or ls) lists OAuth-capable servers and their auth status.

Removes OAuth credentials for an MCP server.

Debugs OAuth connection issues for an MCP server: shows auth status, tests HTTP connectivity and attempts OAuth discovery.

Lists all models available from configured providers in provider/model format, optionally filtered by provider ID.

Runs OpenCode non-interactively by passing a prompt directly; useful for scripting and automation, and can attach to a running serve instance.

Starts a headless OpenCode HTTP server for API access without the TUI. Set OPENCODE_SERVER_PASSWORD to enable HTTP basic auth.

Manages OpenCode sessions.

Lists all OpenCode sessions.

Deletes an OpenCode session.

Shows token usage and cost statistics for OpenCode sessions.

Exports session data as JSON; prompts for a session if no ID is given.

Imports session data from a JSON file.

Starts a headless OpenCode server with a web interface and opens a browser. Set OPENCODE_SERVER_PASSWORD to enable HTTP basic auth.

Starts an ACP (Agent Client Protocol) server that communicates via stdin/stdout using nd-JSON.

Installs a plugin and updates your config. Alias: plug.

Fetches and checks out a GitHub PR branch, then runs OpenCode.

Database tools; optionally runs a query.

Prints the database path.

Debugging and troubleshooting tools. opencode debug config shows the resolved config, including managed preference keys.

Uninstalls OpenCode and removes all related files.

Updates opencode to the latest version or a specific version.