OpenCode in IDE

Christopher Tso 6dc4e5ac93 Make CLI build script Windows-friendly (#5835) 2 months ago
.github da6e0e60c0 ci: adjust review agent prompt to discourage bad diffs 2 months ago
.husky 776091cc23 ci: add bun version check to pre-push hook to ensure version consistency 2 months ago
.opencode 4bad6f9f1b tweak: use fetch instead of octokit for now 2 months ago
.vscode 066a876f3d docs(contributing): Add "Setting up a Debugger" section (#4421) 3 months ago
github 8f6c8844d7 feat: support configuring a default_agent across all API/user surfaces (#5843) 2 months ago
infra 57120e69ed Zen: sync 2 months ago
logs 1ea3a8eb9b big format 3 months ago
nix 695fdecf23 Update Nix flake.lock and hashes 2 months ago
packages 6dc4e5ac93 Make CLI build script Windows-friendly (#5835) 2 months ago
patches 9111005165 fix: terminal serialization and isolation 2 months ago
script 35c12e2053 ci 2 months ago
sdks 0b046d6cf0 release: v1.0.182 2 months ago
specs f993541e0b Refactor to support multiple instances inside single opencode process (#2360) 5 months ago
.editorconfig dd22cb2bb0 chore: add .editorconfig (#536) 7 months ago
.gitignore 289b2b6a51 docs: add legal pages with privacy policy and terms of service links 2 months ago
.prettierignore 28c802f399 wip: zen 2 months ago
AGENTS.md 5b34636afa ignore: docs & style 2 months ago
CONTRIBUTING.md 26d0280f70 docs: contributing 2 months ago
LICENSE ef3fd5900f docs: cleanup casing 8 months ago
README.md 2e853911c3 docs: replace deprecated mise ubi backend with github backend (#5811) 2 months ago
README.zh-TW.md c81506b28d docs: add Traditional Chinese (Taiwan) README translation (#5861) 2 months ago
STATS.md f6bdeb9e3a ignore: update download stats 2025-12-20 2 months ago
STYLE_GUIDE.md 5b34636afa ignore: docs & style 2 months ago
bun.lock 0b046d6cf0 release: v1.0.182 2 months ago
bunfig.toml 995b23787c ci 3 months ago
flake.lock a0ab3d98b7 Update Nix flake.lock and hashes 2 months ago
flake.nix 5e13527416 feat: nix support for the nix folks (#3924) 3 months ago
install 62f080b0e4 fix: small bug w/ install script 2 months ago
package.json 054d22791d zen: sync 2 months ago
sst-env.d.ts 57120e69ed Zen: sync 2 months ago
sst.config.ts 59a3e7e3cc ci: ignore 2 months ago
tsconfig.json 925ce6503e sync 4 months ago
turbo.json 8bea479df9 ci: wtf 4 months ago

README.md

OpenCode logo

The open source AI coding agent.

Discord npm Build status

OpenCode Terminal UI


Installation

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

# Package managers
npm i -g opencode-ai@latest        # or bun/pnpm/yarn
scoop bucket add extras; scoop install extras/opencode  # Windows
choco install opencode             # Windows
brew install opencode              # macOS and Linux
paru -S opencode-bin               # Arch Linux
mise use -g github:sst/opencode # Any OS
nix run nixpkgs#opencode           # or github:sst/opencode for latest dev branch

[!TIP] Remove versions older than 0.1.x before installing.

Desktop App (BETA)

OpenCode is also available as a desktop application. Download directly from the releases page or opencode.ai/download.

Platform Download
macOS (Apple Silicon) opencode-desktop-darwin-aarch64.dmg
macOS (Intel) opencode-desktop-darwin-x64.dmg
Windows opencode-desktop-windows-x64.exe
Linux .deb, .rpm, or AppImage
# macOS (Homebrew)
brew install --cask opencode-desktop

Installation Directory

The install script respects the following priority order for the installation path:

  1. $OPENCODE_INSTALL_DIR - Custom installation directory
  2. $XDG_BIN_DIR - XDG Base Directory Specification compliant path
  3. $HOME/bin - Standard user binary directory (if exists or can be created)
  4. $HOME/.opencode/bin - Default fallback

    # Examples
    OPENCODE_INSTALL_DIR=/usr/local/bin curl -fsSL https://opencode.ai/install | bash
    XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash
    

Agents

OpenCode includes two built-in agents you can switch between, you can switch between these using the Tab key.

  • build - Default, full access agent for development work
  • plan - Read-only agent for analysis and code exploration
    • Denies file edits by default
    • Asks permission before running bash commands
    • Ideal for exploring unfamiliar codebases or planning changes

Also, included is a general subagent for complex searches and multi-step tasks. This is used internally and can be invoked using @general in messages.

Learn more about agents.

Documentation

For more info on how to configure OpenCode head over to our docs.

Contributing

If you're interested in contributing to OpenCode, please read our contributing docs before submitting a pull request.

Building on OpenCode

If you are working on a project that's related to OpenCode and is using "opencode" as a part of its name; for example, "opencode-dashboard" or "opencode-mobile", please add a note to your README to clarify that it is not built by the OpenCode team and is not affiliated with us in any way.

FAQ

How is this different than Claude Code?

It's very similar to Claude Code in terms of capability. Here are the key differences:

  • 100% open source
  • Not coupled to any provider. Although we recommend the models we provide through OpenCode Zen; OpenCode can be used with Claude, OpenAI, Google or even local models. As models evolve the gaps between them will close and pricing will drop so being provider-agnostic is important.
  • Out of the box LSP support
  • A focus on TUI. OpenCode is built by neovim users and the creators of terminal.shop; we are going to push the limits of what's possible in the terminal.
  • A client/server architecture. This for example can allow OpenCode to run on your computer, while you can drive it remotely from a mobile app. Meaning that the TUI frontend is just one of the possible clients.

What's the other repo?

The other confusingly named repo has no relation to this one. You can read the story behind it here.


Join our community Discord | X.com