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
Что это такое?OpenCode — это открытый ИИ-агент для программирования, который помогает писать, изучать и редактировать код. Доступен как CLI, а теперь также как бета-версия десктопного приложения.
Это инструмент для терминала или есть и десктопное приложение?В первую очередь это CLI-агент, но OpenCode также выпускает БЕТА-версию десктопного приложения, которое можно скачать напрямую для macOS, Windows и Linux.
Как установить OpenCode?Скачайте десктопное приложение на opencode.ai/download или на странице GitHub releases (dmg для macOS на Apple Silicon/Intel, .exe для Windows, .deb/.rpm/.AppImage для Linux), либо запустите скрипт установки, который сам выберет директорию для установки.
Можно ли пользоваться десктопным приложением каждый день?Пока нет — десктопное приложение явно помечено как БЕТА, поэтому сейчас CLI — более зрелый способ работать с OpenCode.
Какие встроенные агенты есть в OpenCode?В OpenCode есть агент build (используется по умолчанию, полный доступ к редактированию файлов для разработки) и агент plan (только чтение: не редактирует файлы, спрашивает разрешение перед запуском bash-команд, удобен для изучения незнакомого кода). Также внутри работает субагент general, который выполняет сложные многошаговые поиски.
Как переключаться между агентами build и plan?В CLI нажмите клавишу Tab, чтобы переключаться между агентами build и plan.
Можно ли вызвать субагент general напрямую?Да, его можно явно вызвать в сообщениях через @general для сложных поисков или многошаговых задач.
Можно ли создать собственный инструмент на основе OpenCode?Да, но если в названии вашего проекта есть «opencode», нужно добавить в README пометку, что проект не создан командой OpenCode и не связан с ней.
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