Skip to content

README.md

Latest commit

 

History

History
202 lines (150 loc) · 8.38 KB

README.md

File metadata and controls

202 lines (150 loc) · 8.38 KB

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

Логирование

opencode

Запуск через MinIO

Основной способ локального запуска в этом репозитории:

./run-opencode-with-minio.sh

Скрипт нужно запускать из корня репозитория, потому что он:

  1. Читает переменные из ./.env.
  2. Подставляет значения для S3/MinIO, если они не заданы.
  3. Запускает bun run dev -- --print-logs --log-level DEBUG.

Что нужно перед запуском

  1. Установить зависимости:
bun install
  1. Поднять MinIO на http://localhost:9000.
  2. Убедиться, что в MinIO существует bucket my_bucket, либо переопределить его через переменную OPENCODE_LOGS_S3_BUCKET.
  3. Подготовить .env в корне репозитория, если проекту нужны дополнительные переменные.

Переменные по умолчанию

Если переменные не заданы в окружении или в .env, скрипт использует такие значения:

AWS_ACCESS_KEY_ID=minioadmin
AWS_SECRET_ACCESS_KEY=minioadmin
AWS_ENDPOINT_URL=http://localhost:9000
AWS_DEFAULT_REGION=ru-central-1
OPENCODE_LOGS_S3_BUCKET=my_bucket
OPENCODE_LOGS_S3_PREFIX=dev

Логи телеметрии будут зеркалироваться в указанный S3-совместимый bucket через MinIO.

Что именно запускается

Команда bun run dev берется из корневого package.json и стартует пакет packages/opencode:

bun run --cwd packages/opencode --conditions=browser src/index.ts --print-logs --log-level DEBUG

Если запуск не стартует

Проверьте:

  1. Что команда выполняется из корня репозитория.
  2. Что MinIO доступен по AWS_ENDPOINT_URL.
  3. Что bucket существует и учетные данные подходят.
  4. Что bun install уже был выполнен.

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-darwin-aarch64.dmg
macOS (Intel) opencode-desktop-darwin-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.

  • 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