OpenCode in IDE

Jay V f436a50125 docs: share header 8 months ago
.github a85b0a370e ci: share 8 months ago
infra 261bb7f110 Infra: fix DO tag 8 months ago
packages f436a50125 docs: share header 8 months ago
patches ee91f31313 fix issue with tool schemas and google 8 months ago
scripts 3862184ccb hooks 8 months ago
.gitignore bd46cf0f86 feat(tui): configurable keybinds and mouse scroll 8 months ago
LICENSE f3da73553c sync 8 months ago
README.md 46ab9c16dd docs: Update README.md 8 months ago
bun.lock 41dba0db08 config validation 8 months ago
bunfig.toml 1472efcbfe Optimize package management with catalog and exact versions 8 months ago
install ec928d88b5 fix(install): check if the path export command already exists (#28) 8 months ago
opencode.json a300bfaccb docs: remove opencode.json 8 months ago
package.json 3862184ccb hooks 8 months ago
sst-env.d.ts 028d589ea0 Infra: use Astro component 8 months ago
sst.config.ts f3da73553c sync 8 months ago
tsconfig.json f3da73553c sync 8 months ago

README.md

opencode logo

AI coding agent, built for the terminal.

View docs 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
brew install sst/tap/opencode      # macOS
paru -S opencode-bin               # Arch Linux

Note: Remove versions older than 0.1.x before installing

Documentation

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

Contributing

To run opencode locally you need.

  • Bun
  • Golang 1.24.x

And run.

$ bun install
$ bun run packages/opencode/src/index.ts

FAQ

How do I use this with OpenRouter?

OpenRouter is not in the Models.dev database yet, but you can configure it manually.

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "openrouter": {
      "npm": "@openrouter/ai-sdk-provider",
      "name": "OpenRouter",
      "options": {},
      "models": {
        "anthropic/claude-3.5-sonnet": {
          "name": "Claude 3.5 Sonnet"
        }
      }
    }
  }
}

And then to configure an api key you can do opencode auth login and select "Other -> 'openrouter'"

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.
  • 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 about Windows support?

There are some minor problems blocking opencode from working on windows. We are working on on them now. You'll need to use WSL for now.

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 YouTube | X.com