opencode README

The project's README from github.com/anomalyco/opencode. As one markdown file: README.md.

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.

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-mac-arm64.dmg
macOS (Intel) opencode-desktop-mac-x64.dmg
Windows opencode-desktop-windows-x64.exe
Linux .deb, .rpm, or .AppImage 
# 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.

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.

Join our community Discord | X.com

opencode (anomalyco/opencode)

Searching Database…

214.4K ·GitHub
Opencode
What is this?OpenCode is an open source AI coding agent that helps you write, explore, and edit code, available as a CLI and now also as a beta desktop app.
Is this a terminal tool, or does it have a desktop app too?It is primarily a CLI agent, but OpenCode also ships a BETA desktop application you can download directly for macOS, Windows, and Linux.
How do I install OpenCode?Grab the desktop app from opencode.ai/download or the GitHub releases page (dmg for macOS Apple Silicon/Intel, .exe for Windows, .deb/.rpm/.AppImage for Linux), or run the install script, which picks an install directory for you.
Is the desktop app ready for everyday use?Not fully — the desktop app is explicitly marked as BETA, so the CLI is the more mature way to use OpenCode right now.
What built-in agents come with OpenCode?OpenCode ships with a build agent (default, full file-editing access for development) and a plan agent (read-only, denies file edits and asks permission before running bash commands, good for exploring unfamiliar code). A general subagent also handles complex multistep searches internally.
How do I switch between the build and plan agents?Press the Tab key in the CLI to toggle between the build and plan agents.
Can I invoke the general subagent directly?Yes, you can call it explicitly in messages using @general for complex searches or multistep tasks.
Can I build my own tool on top of OpenCode?Yes, but if your project uses 'opencode' in its name you're asked to add a README note clarifying it isn't made by or affiliated with the OpenCode team.
What are similar projects?pi-gui, qwen-code, oh-my-pi, billion-context, MiMo-Code, agent-router, continue, 99
Which topics is it in?ai-coding-agent, discord, bun, sdk, agents, coding-agent, plugin, desktop, agent, desktop-app, terminal, ai-agents
Creator
anomalyco
Size
564 MB
Stars
214.4K
Updated
CommitOct 17Releasev1.19.3Oct 16
Age
1y
Commits · 90 Days