OpenCode in IDE

Aiden Cline de35c3fb84 ci: ignore 3 months ago
.github de35c3fb84 ci: ignore 3 months ago
.husky 96bdeb3c7b OpenTUI is here (#2685) 3 months ago
.opencode 55b57e1aae ci: tweak 3 months ago
.vscode 066a876f3d docs(contributing): Add "Setting up a Debugger" section (#4421) 3 months ago
github b5cc27b8ea chore: format code 3 months ago
infra 6ecaf83f76 chore: format code 3 months ago
logs 1ea3a8eb9b big format 3 months ago
nix 4359719f9a ignore: format 3 months ago
packages 5e13527416 feat: nix support for the nix folks (#3924) 3 months ago
patches 854f9227a2 Patch Start to preload route css in SSR (#2389) 5 months ago
script 767038afc3 ci: update zed sync 3 months ago
sdks ff7513238b release: v1.0.72 3 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 5e13527416 feat: nix support for the nix folks (#3924) 3 months ago
AGENTS.md 1ea3a8eb9b big format 3 months ago
CONTRIBUTING.md 066a876f3d docs(contributing): Add "Setting up a Debugger" section (#4421) 3 months ago
LICENSE ef3fd5900f docs: cleanup casing 8 months ago
README.md 5e13527416 feat: nix support for the nix folks (#3924) 3 months ago
STATS.md 9fd43ec616 ignore: update download stats 2025-11-17 3 months ago
a.out a1214fff2e Refactor agent loop (#4412) 3 months ago
bun.lock ddddecf88a chore: format code 3 months ago
bunfig.toml 995b23787c ci 3 months ago
flake.lock 5e13527416 feat: nix support for the nix folks (#3924) 3 months ago
flake.nix 5e13527416 feat: nix support for the nix folks (#3924) 3 months ago
install 36b48a44ac tweak - normalise unix-like identifiers to support git bash for windows (#2100) 3 months ago
package.json 37fdcac05a ci 3 months ago
sst-env.d.ts b5cc27b8ea chore: format code 3 months ago
sst.config.ts bfe3f03e03 ci: fix deploy 4 months ago
tsconfig.json 925ce6503e sync 4 months ago
turbo.json 8bea479df9 ci: wtf 4 months ago

README.md

OpenCode logo

The AI coding agent built for the terminal.

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 --pin -g ubi: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.

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 anyway.

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 Anthropic is recommended, OpenCode can be used with 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