OpenCode in IDE

Conor O'Brien d097c546db nit: update commands displayed on home to match commands available (#108) 8 months ago
.github 59a5f120c0 Clean up workflows and enhance file discovery tools to include dot files 8 months ago
infra 028d589ea0 Infra: use Astro component 8 months ago
packages d097c546db nit: update commands displayed on home to match commands available (#108) 8 months ago
scripts 289f6af3de CI (#43) 10 months ago
.gitignore 01050a430f wip: refactoring tui 8 months ago
LICENSE f3da73553c sync 8 months ago
README.md 2ea0399aa7 docs: use ollama example 8 months ago
bun.lock fa1266263d downgrade to ai sdk v4.x 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 2ea0399aa7 docs: use ollama example 8 months ago
package.json fa1266263d downgrade to ai sdk v4.x 8 months ago
screenshot.png 168fd9b2e3 screenshot 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 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"
    }
  }
}

Providers

You can use opencode with any provider listed at here. Use the npm package name as the key in your config. Note we use v5 of the ai-sdk and not all providers support that yet.

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "@ai-sdk/openai-compatible": {
      "name": "ollama",
      "options": {
        "baseURL": "http://localhost:11434/v1"
      },
      "models": {
        "llama2": {
          "name": "llama2"
        }
      }
    }
  }
}

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 OpenRou?ter

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

{
  "$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"
        }
      }
    }
  }
}