CLI

Running the opencode CLI starts it for the current directory.

opencode

Or you can start it for a specific working directory.

opencode /path/to/project

---

Slash commands

When using the opencode CLI, you can type / followed by a command name to quickly execute actions. For example:

Tip

You can also use @ to reference files in your messages.

/help

Here are all available slash commands:

• /help

  Show the help dialog.

• /editor

  Open external editor for composing messages. Uses the editor set in your EDITOR environment variable. Learn more.

• /export

  Export current conversation to Markdown and open in your default editor. Uses the editor set in your EDITOR environment variable. Learn more.

• /new

  Start a new session. Alias: /clear

• /sessions

  List and switch between sessions. Aliases: /resume, /continue

• /share

  Share current session. Learn more.

• /unshare

  Unshare current session. Learn more.

• /compact

  Compact the current session. Alias: /summarize

• /details

  Toggle tool execution details.

• /models

  List available models.

• /themes

  List available themes.

• /init

  Create or update AGENTS.md file. Learn more.

• /undo

  Undo last message.

• /redo

  Redo message.

• /exit

  Exit opencode. Aliases: /quit, /q

---

Editor setup

Both the /editor and /export commands use the editor specified in your EDITOR environment variable.

Linux/macOS

bash export EDITOR=nano # or vim, code, etc. To make it permanent, add this to your shell profile; ~/.bashrc, ~/.zshrc, etc.

Windows (CMD)

bash set EDITOR=notepad # or code, vim, etc. To make it permanent, use System Properties > Environment Variables.

Windows (PowerShell)

bash $env:EDITOR = "notepad" # or "code", "vim", etc. To make it permanent, add this to your PowerShell profile.

Popular editor options include:

• code - Visual Studio Code
• vim - Vim editor
• nano - Nano editor
• notepad - Windows Notepad
• subl - Sublime Text

---

Commands

The opencode CLI also has the following commands.

---

agent

Manage agents for opencode.

opencode agent [command]

---

create

Create a new agent with custom configuration.

opencode agent create

This command will guide you through creating a new agent with a custom system prompt and tool configuration.

---

auth

Command to manage credentials and login for providers.

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.

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.

---

list

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

opencode auth list

Or the short version.

opencode auth ls

---

logout

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

opencode auth logout

---

github

Manage the GitHub agent for repository automation.

opencode github [command]

---

install

Install the GitHub agent in your repository.

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.

opencode github run

Flags

Flag	Description
--event	GitHub mock event to run the agent for
--token	GitHub personal access token

---

models

List all available models from configured providers.

opencode models

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

---

run

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

opencode run [message..]

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

opencode run Explain the use of context in Go

Flags

Flag	Short	Description
--continue	-c	Continue the last session
--session	-s	Session ID to continue
--share		Share the session
--model	-m	Model to use in the form of provider/model
--agent		Agent to use

---

serve

Start a headless opencode server for API access.

opencode serve

This starts an HTTP server that provides API access to opencode functionality without the TUI interface.

Flags

Flag	Short	Description
--port	-p	Port to listen on
--hostname	-h	Hostname to listen on

---

upgrade

Updates opencode to the latest version or a specific version.

opencode upgrade [target]

To upgrade to the latest version.

opencode upgrade

To upgrade to a specific version.

opencode upgrade v0.1.48

Flags

Flag	Short	Description
--method	-m	The installation method that was used; curl, npm, pnpm, bun, brew

---

Flags

The opencode CLI takes the following global flags.

Flag	Short	Description
--help	-h	Display help
--version		Print version number
--print-logs		Print logs to stderr
--log-level		Log level (DEBUG, INFO, WARN, ERROR)
--prompt	-p	Prompt to use
--model	-m	Model to use in the form of provider/model
--mode		Mode to use
--port		Port to listen on
--hostname		Hostname to listen on