OpenCode in IDE

Dax Raad eaf295bac7 docs: faq 8 meses atrás
.github 59a5f120c0 Clean up workflows and enhance file discovery tools to include dot files 8 meses atrás
infra 028d589ea0 Infra: use Astro component 8 meses atrás
packages 27d3cec477 typo (#94) 8 meses atrás
scripts 289f6af3de CI (#43) 10 meses atrás
.gitignore 01050a430f wip: refactoring tui 8 meses atrás
LICENSE f3da73553c sync 8 meses atrás
README.md eaf295bac7 docs: faq 8 meses atrás
bun.lock af892e5432 docs: readme 8 meses atrás
bunfig.toml 1472efcbfe Optimize package management with catalog and exact versions 8 meses atrás
install ec928d88b5 fix(install): check if the path export command already exists (#28) 8 meses atrás
opencode.json 574d494c3c Enhance provider system with dynamic package resolution and improved logging 8 meses atrás
package.json a53f9165e9 doc: remove dev script 8 meses atrás
screenshot.png 168fd9b2e3 screenshot 8 meses atrás
sst-env.d.ts 028d589ea0 Infra: use Astro component 8 meses atrás
sst.config.ts f3da73553c sync 8 meses atrás
tsconfig.json f3da73553c sync 8 meses atrás

README.md

OpenCode Terminal UI

AI coding agent, built for the terminal.

⚠️ Note: version 0.1.x is a full rewrite and we do not have proper documentation for it yet. Should have this out week of June 17th 2025 📚

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 previous versions < 0.1.x first if installed

Providers

The recommended approach is to sign up for claude pro or max and do opencode auth login and select Anthropic. It is the most cost effective way to use this tool.

Additionally 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

┌  Add credential
│
◆  Select provider
│  ● Anthropic (recommended)
│  ○ OpenAI
│  ○ Google
│  ○ Amazon Bedrock
│  ○ Azure
│  ○ DeepSeek
│  ○ Groq
│  ...
└

The models.dev dataset is also used to detect common environment variables like OPENAI_API_KEY to autoload that provider.

If there are additional providers you want to use you can submit a PR to the models.dev repo. If configuring just for yourself check out the Config section below

Project Config

Project configuration is optional. You can place an opencode.json file in the root of your repo and it will be loaded.

{
  "$schema": "http://opencode.ai/config.json"
}

MCP

{
  "$schema": "http://opencode.ai/config.json",
  "mcp": {
    "localmcp": {
      "type": "local",
      "command": ["bun", "x", "my-mcp-command"],
      "environment": {
        "MY_ENV_VAR": "my_env_var_value"
      }
    },
    "remotemcp": {
      "type": "remote",
      "url": "https://my-mcp-server.com"
    }
  }
}

Contributing

To run opencode locally you need

  • bun
  • golang 1.24.x

To run

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

FAQ

How do I use this with OpenRouter

Theoretically you can use this with OpenRouter with config like this

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

However we are using ai-sdk v5 which OpenRouter does not support yet. The moment they do this will work