Skip to content

finedesignz/opencode

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12,161 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenCode logo

The open source AI coding agent.

Discord npm Build status

English | 简体中文 | 繁體中文 | 한국어 | Deutsch | Español | Français | Italiano | Dansk | 日本語 | Polski | Русский | Bosanski | العربية | Norsk | Português (Brasil) | ไทย | Türkçe | Українська | বাংলা | Ελληνικά | Tiếng Việt

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 install opencode             # Windows
choco install opencode             # Windows
brew install anomalyco/tap/opencode # macOS and Linux (recommended, always up to date)
brew install opencode              # macOS and Linux (official brew formula, updated less)
sudo pacman -S opencode            # Arch Linux (Stable)
paru -S opencode-bin               # Arch Linux (Latest from AUR)
mise use -g opencode               # Any OS
nix run nixpkgs#opencode           # or github:anomalyco/opencode for latest dev branch

Tip

Remove versions older than 0.1.x before installing.


Fork additions: Claude subscription + Claude Code delegation

This fork (finedesignz/opencode) adds two providers and a localhost WebSocket route that aren't in upstream:

claude-subscription/* — use your Claude Pro/Max subscription, no API key

Picks up your existing OAuth token from ~/.claude/.credentials.json (the same file claude CLI writes when you run claude auth login) and routes opencode's normal LLM loop through it. No Anthropic API key needed.

# Pre-req: log in once via the official Claude Code CLI
claude auth login

# Then in opencode, pick the model:
#   claude-subscription/claude-sonnet-4-5
#   claude-subscription/claude-opus-4-5
#   claude-subscription/claude-haiku-4-5

Token refresh, write-back to ~/.claude, and cross-process locking are handled automatically. If claude CLI rotates the token mid-session, opencode picks up the change via file watcher.

claude-code/* — delegate full turns to local claude CLI

Picking a claude-code/* model bypasses opencode's native LLM loop and spawns claude -p --output-format stream-json per turn. Claude Code runs its own agentic loop (its tools, hooks, skills, MCPs) inside opencode's session, with every tool call gated through opencode's permission UI via a PreToolUse hook callback.

# Pre-req: install the Claude Code CLI
npm install -g @anthropic-ai/claude-code

# Then in opencode, pick:
#   claude-code/claude-sonnet-4-5  (or opus / haiku)

Tool calls render with full diff/output fidelity for cc:Read, cc:Write, cc:Edit, cc:Bash (other cc:* tools fall back to a generic card). Sessions can interleave native opencode turns with claude-code turns; CC session continuity is preserved via --resume.

Configurable in opencode.json:

{
  "provider": {
    "claude-subscription": { "enabled": true },
    "claude-code": {
      "enabled": true,
      "binPath": "claude",
      "permissionTimeout": 300,
      "permissionFailMode": "deny",
      "maxConsecutiveDeniedTools": 3
    }
  },
  "compaction": {
    "fallbackModel": "claude-subscription/claude-haiku-4-5"
  }
}

Localhost WebSocket route (/ws)

Bidirectional WS endpoint that mirrors /event SSE plus accepts inbound prompt and permission messages. Useful for building custom local web clients. Origin-checked, proxy-header-rejected, no auth token required (localhost-only by design — do not expose).

Design + plan docs


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

Fork builds: Releases of this fork (with claude-subscription / claude-code providers) are published at finedesignz/opencode/releases. The Windows installer is opencode-electron-win-x64.exe.

CI builds are produced by .github/workflows/fork-build-win.yml — trigger manually from the Actions tab, or push a tag matching v*-fork.* / v*-claude.*. The workflow:

  1. Builds packages/desktop-electron for Windows.
  2. Signs the installer if the repo has secrets WIN_CODE_SIGNING_PFX_BASE64 (base64-encoded PFX) and WIN_CODE_SIGNING_PFX_PASSWORD.
  3. Uploads the signed installer as a workflow artifact and (for tag pushes) attaches it to a GitHub release.

Local build: bun install && bun run --cwd packages/desktop-electron prebuild && bun run --cwd packages/desktop-electron build && bun run --cwd packages/desktop-electron package:win — output at packages/desktop-electron/dist/opencode-electron-win-x64.exe.

# macOS (Homebrew)
brew install --cask opencode-desktop
# Windows (Scoop)
scoop bucket add extras; scoop install extras/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 it 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 with 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 multistep 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 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 from 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 drive it remotely from a mobile app, meaning that the TUI frontend is just one of the possible clients.

Join our community Discord | X.com

About

The open source coding agent.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 60.1%
  • MDX 36.3%
  • CSS 2.8%
  • Rust 0.4%
  • Astro 0.2%
  • JavaScript 0.1%
  • Other 0.1%