142 lines
10 KiB
Markdown
142 lines
10 KiB
Markdown
<p align="center">
|
||
<a href="https://opencode.ai">
|
||
<picture>
|
||
<source srcset="packages/console/app/src/asset/logo-ornate-dark.svg" media="(prefers-color-scheme: dark)">
|
||
<source srcset="packages/console/app/src/asset/logo-ornate-light.svg" media="(prefers-color-scheme: light)">
|
||
<img src="packages/console/app/src/asset/logo-ornate-light.svg" alt="OpenCode logo">
|
||
</picture>
|
||
</a>
|
||
</p>
|
||
<p align="center">āĻāĻĒā§āύ āϏā§āϰā§āϏ āĻāĻāĻ āĻā§āĻĄāĻŋāĻ āĻāĻā§āύā§āĻāĨ¤</p>
|
||
<p align="center">
|
||
<a href="https://opencode.ai/discord"><img alt="Discord" src="https://img.shields.io/discord/1391832426048651334?style=flat-square&label=discord" /></a>
|
||
<a href="https://www.npmjs.com/package/opencode-ai"><img alt="npm" src="https://img.shields.io/npm/v/opencode-ai?style=flat-square" /></a>
|
||
<a href="https://github.com/anomalyco/opencode/actions/workflows/publish.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/anomalyco/opencode/publish.yml?style=flat-square&branch=dev" /></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="README.md">English</a> |
|
||
<a href="README.zh.md">įŽäŊ䏿</a> |
|
||
<a href="README.zht.md">įšéĢ䏿</a> |
|
||
<a href="README.ko.md">íęĩė´</a> |
|
||
<a href="README.de.md">Deutsch</a> |
|
||
<a href="README.es.md">EspaÃąol</a> |
|
||
<a href="README.fr.md">Français</a> |
|
||
<a href="README.it.md">Italiano</a> |
|
||
<a href="README.da.md">Dansk</a> |
|
||
<a href="README.ja.md">æĨæŦčĒ</a> |
|
||
<a href="README.pl.md">Polski</a> |
|
||
<a href="README.ru.md">Đ ŅŅŅĐēиК</a> |
|
||
<a href="README.bs.md">Bosanski</a> |
|
||
<a href="README.ar.md">Ø§ŲØšØąØ¨ŲØŠ</a> |
|
||
<a href="README.no.md">Norsk</a> |
|
||
<a href="README.br.md">PortuguÃĒs (Brasil)</a> |
|
||
<a href="README.th.md">āšā¸ā¸ĸ</a> |
|
||
<a href="README.tr.md">TÃŧrkçe</a> |
|
||
<a href="README.uk.md">ĐŖĐēŅаŅĐŊŅŅĐēа</a> |
|
||
<a href="README.bn.md">āĻŦāĻžāĻāϞāĻž</a> |
|
||
<a href="README.gr.md">ÎÎģÎģΡÎŊΚÎēÎŦ</a> |
|
||
<a href="README.vi.md">Tiáēŋng Viáģt</a>
|
||
</p>
|
||
|
||
[](https://opencode.ai)
|
||
|
||
---
|
||
|
||
### āĻāύāϏā§āĻāϞā§āĻļāύ (Installation)
|
||
|
||
```bash
|
||
# 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]
|
||
> āĻāύāϏā§āĻāϞ āĻāϰāĻžāϰ āĻāĻā§ ā§Ļ.ā§§.x āĻāϰ āĻā§ā§ā§ āĻĒā§āϰā§āύ⧠āĻāĻžāϰā§āϏāύāĻā§āϞ⧠āĻŽā§āĻā§ āĻĢā§āϞā§āύāĨ¤
|
||
|
||
### āĻĄā§āϏā§āĻāĻāĻĒ āĻ
ā§āϝāĻžāĻĒ (BETA)
|
||
|
||
OpenCode āĻĄā§āϏā§āĻāĻāĻĒ āĻ
ā§āϝāĻžāĻĒā§āϞāĻŋāĻā§āĻļāύ āĻšāĻŋāϏā§āĻŦā§āĻ āĻāĻĒāϞāĻŦā§āϧāĨ¤ āϏāϰāĻžāϏāϰāĻŋ [āϰāĻŋāϞāĻŋāĻ āĻĒā§āĻ](https://github.com/anomalyco/opencode/releases) āĻ
āĻĨāĻŦāĻž [opencode.ai/download](https://opencode.ai/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` |
|
||
|
||
```bash
|
||
# macOS (Homebrew)
|
||
brew install --cask opencode-desktop
|
||
# Windows (Scoop)
|
||
scoop bucket add extras; scoop install extras/opencode-desktop
|
||
```
|
||
|
||
#### āĻāύāϏā§āĻāϞā§āĻļāύ āĻĄāĻŋāϰā§āĻā§āĻāϰāĻŋ (Installation Directory)
|
||
|
||
āĻāύāϏā§āĻāϞ āϏā§āĻā§āϰāĻŋāĻĒā§āĻāĻāĻŋ āĻāύāϏā§āĻāϞā§āĻļāύ āĻĒāĻžāϤā§āϰ āĻāύā§āϝ āύāĻŋāĻŽā§āύāϞāĻŋāĻāĻŋāϤ āĻ
āĻā§āϰāĻžāϧāĻŋāĻāĻžāϰ āĻā§āϰāĻŽ āĻŽā§āύ⧠āĻāϞā§:
|
||
|
||
1. `$OPENCODE_INSTALL_DIR` - āĻāĻžāϏā§āĻāĻŽ āĻāύāϏā§āĻāϞā§āĻļāύ āĻĄāĻŋāϰā§āĻā§āĻāϰāĻŋ
|
||
2. `$XDG_BIN_DIR` - XDG āĻŦā§āϏ āĻĄāĻŋāϰā§āĻā§āĻāϰāĻŋ āϏā§āĻĒā§āϏāĻŋāĻĢāĻŋāĻā§āĻļāύ āϏāĻŽāϰā§āĻĨāĻŋāϤ āĻĒāĻžāĻĨ
|
||
3. `$HOME/bin` - āϏāĻžāϧāĻžāϰāĻŖ āĻŦā§āϝāĻŦāĻšāĻžāϰāĻāĻžāϰ⧠āĻŦāĻžāĻāύāĻžāϰāĻŋ āĻĄāĻŋāϰā§āĻā§āĻāϰāĻŋ (āϝāĻĻāĻŋ āĻŦāĻŋāĻĻā§āϝāĻŽāĻžāύ āĻĨāĻžāĻā§ āĻŦāĻž āϤā§āϰāĻŋ āĻāϰāĻž āϝāĻžā§)
|
||
4. `$HOME/.opencode/bin` - āĻĄāĻŋāĻĢāϞā§āĻ āĻĢāϞāĻŦā§āϝāĻžāĻ
|
||
|
||
```bash
|
||
# āĻāĻĻāĻžāĻšāϰāĻŖ
|
||
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 āĻ āĻĻā§āĻāĻŋ āĻŦāĻŋāϞā§āĻ-āĻāύ āĻāĻā§āύā§āĻ āϰāϝāĻŧā§āĻā§ āϝāĻž āĻāĻĒāύāĻŋ `Tab` āĻāĻŋ(key) āĻĻāĻŋāϝāĻŧā§ āĻĒāϰāĻŋāĻŦāϰā§āϤāύ āĻāϰāϤ⧠āĻĒāĻžāϰāĻŦā§āύāĨ¤
|
||
|
||
- **build** - āĻĄāĻŋāĻĢāϞā§āĻ, āĻĄā§āĻā§āϞāĻĒāĻŽā§āύā§āĻā§āϰ āĻāĻžāĻā§āϰ āĻāύā§āϝ āϏāĻŽā§āĻĒā§āϰā§āĻŖ āĻ
ā§āϝāĻžāĻā§āϏā§āϏāϝā§āĻā§āϤ āĻāĻā§āύā§āĻ
|
||
- **plan** - āĻŦāĻŋāĻļā§āϞā§āώāĻŖ āĻāĻŦāĻ āĻā§āĻĄ āĻāĻā§āϏāĻĒā§āϞā§āϰā§āĻļāύā§āϰ āĻāύā§āϝ āϰāĻŋāĻĄ-āĻāύāϞāĻŋ āĻāĻā§āύā§āĻ
|
||
- āĻĄāĻŋāĻĢāϞā§āĻāĻāĻžāĻŦā§ āĻĢāĻžāĻāϞ āĻāĻĄāĻŋāĻ āĻāϰāϤ⧠āĻĻā§āϝāĻŧ āύāĻž
|
||
- āĻŦā§āϝāĻžāĻļ āĻāĻŽāĻžāύā§āĻĄ āĻāĻžāϞāĻžāύā§āϰ āĻāĻā§ āĻ
āύā§āĻŽāϤāĻŋ āĻāĻžā§
|
||
- āĻ
āĻĒāϰāĻŋāĻāĻŋāϤ āĻā§āĻĄāĻŦā§āϏ āĻāĻā§āϏāĻĒā§āϞā§āϰ āĻāϰāĻž āĻŦāĻž āĻĒāϰāĻŋāĻŦāϰā§āϤāύā§āϰ āĻĒāϰāĻŋāĻāϞā§āĻĒāύāĻž āĻāϰāĻžāϰ āĻāύā§āϝ āĻāĻĻāϰā§āĻļ
|
||
|
||
āĻāĻāĻžā§āĻžāĻ āĻāĻāĻŋāϞ āĻ
āύā§āϏāύā§āϧāĻžāύ āĻāĻŦāĻ āĻŽāĻžāϞā§āĻāĻŋāϏā§āĻā§āĻĒ āĻāĻžāϏā§āĻā§āϰ āĻāύā§āϝ āĻāĻāĻāĻŋ **general** āϏāĻžāĻŦāĻāĻā§āύā§āĻ āĻ
āύā§āϤāϰā§āĻā§āĻā§āϤ āϰāϝāĻŧā§āĻā§āĨ¤
|
||
āĻāĻāĻŋ āĻ
āĻā§āϝāύā§āϤāϰā§āĻŖāĻāĻžāĻŦā§ āĻŦā§āϝāĻŦāĻšā§āϤ āĻšāϝāĻŧ āĻāĻŦāĻ āĻŽā§āϏā§āĻā§ `@general` āϞāĻŋāĻā§ āĻŦā§āϝāĻŦāĻšāĻžāϰ āĻāϰāĻž āϝā§āϤ⧠āĻĒāĻžāϰā§āĨ¤
|
||
|
||
āĻāĻā§āύā§āĻāĻĻā§āϰ āϏāĻŽā§āĻĒāϰā§āĻā§ āĻāϰāĻ āĻāĻžāύā§āύ: [docs](https://opencode.ai/docs/agents)āĨ¤
|
||
|
||
### āĻĄāĻā§āĻŽā§āύā§āĻā§āĻļāύ (Documentation)
|
||
|
||
āĻāĻŋāĻāĻžāĻŦā§ OpenCode āĻāύāĻĢāĻŋāĻāĻžāϰ āĻāϰāĻŦā§āύ āϏ⧠āϏāĻŽā§āĻĒāϰā§āĻā§ āĻāϰāĻ āϤāĻĨā§āϝā§āϰ āĻāύā§āϝ, [**āĻāĻŽāĻžāĻĻā§āϰ āĻĄāĻāϏ āĻĻā§āĻā§āύ**](https://opencode.ai/docs)āĨ¤
|
||
|
||
### āĻ
āĻŦāĻĻāĻžāύ (Contributing)
|
||
|
||
āĻāĻĒāύāĻŋ āϝāĻĻāĻŋ OpenCode āĻ āĻ
āĻŦāĻĻāĻžāύ āϰāĻžāĻāϤ⧠āĻāĻžāύ, āĻ
āύā§āĻā§āϰāĻš āĻāϰ⧠āĻāĻāĻāĻŋ āĻĒā§āϞ āϰāĻŋāĻā§āϝāĻŧā§āϏā§āĻ āϏāĻžāĻŦāĻŽāĻŋāĻ āĻāϰāĻžāϰ āĻāĻā§ āĻāĻŽāĻžāĻĻā§āϰ [āĻāύā§āĻā§āϰāĻŋāĻŦāĻŋāĻāĻāĻŋāĻ āĻĄāĻāϏ](./CONTRIBUTING.md) āĻĒāĻĄāĻŧā§ āύāĻŋāύāĨ¤
|
||
|
||
### OpenCode āĻāϰ āĻāĻĒāϰ āĻŦāĻŋāϞā§āĻĄāĻŋāĻ (Building on OpenCode)
|
||
|
||
āĻāĻĒāύāĻŋ āϝāĻĻāĻŋ āĻāĻŽāύ āĻĒā§āϰāĻā§āĻā§āĻā§ āĻāĻžāĻ āĻāϰā§āύ āϝāĻž OpenCode āĻāϰ āϏāĻžāĻĨā§ āϏāĻŽā§āĻĒāϰā§āĻāĻŋāϤ āĻāĻŦāĻ āĻĒā§āϰāĻā§āĻā§āĻā§āϰ āύāĻžāĻŽā§āϰ āĻ
āĻāĻļ āĻšāĻŋāϏā§āĻŦā§ "opencode" āĻŦā§āϝāĻŦāĻšāĻžāϰ āĻāϰā§āύ, āĻāĻĻāĻžāĻšāϰāĻŖāϏā§āĻŦāϰā§āĻĒ "opencode-dashboard" āĻŦāĻž "opencode-mobile", āϤāĻŦā§ āĻĻāϝāĻŧāĻž āĻāϰ⧠āĻāĻĒāύāĻžāϰ README āϤ⧠āĻāĻāĻāĻŋ āύā§āĻ āϝā§āĻ āĻāϰ⧠āϏā§āĻĒāώā§āĻ āĻāϰā§āύ āϝ⧠āĻāĻ āĻĒā§āϰāĻā§āĻā§āĻāĻāĻŋ OpenCode āĻĻāϞ āĻĻā§āĻŦāĻžāϰāĻž āϤā§āϰāĻŋ āĻšāϝāĻŧāύāĻŋ āĻāĻŦāĻ āĻāĻŽāĻžāĻĻā§āϰ āϏāĻžāĻĨā§ āĻāϰ āĻā§āύ⧠āϏāϰāĻžāϏāϰāĻŋ āϏāĻŽā§āĻĒāϰā§āĻ āύā§āĻāĨ¤
|
||
|
||
### āϏāĻāϰāĻžāĻāϰ āĻāĻŋāĻā§āĻāĻžāϏāĻŋāϤ āĻĒā§āϰāĻļā§āύāĻžāĻŦāϞ⧠(FAQ)
|
||
|
||
#### āĻāĻāĻŋ āĻā§āϞāĻĄ āĻā§āĻĄ (Claude Code) āĻĨā§āĻā§ āĻā§āĻāĻžāĻŦā§ āĻāϞāĻžāĻĻāĻž?
|
||
|
||
āĻā§āϝāĻžāĻĒāĻžāĻŦāĻŋāϞāĻŋāĻāĻŋāϰ āĻĻāĻŋāĻ āĻĨā§āĻā§ āĻāĻāĻŋ āĻā§āϞāĻĄ āĻā§āĻĄā§āϰ (Claude Code) āĻŽāϤāĻāĨ¤ āĻāĻāĻžāύ⧠āĻŽā§āϞ āĻĒāĻžāϰā§āĻĨāĻā§āϝāĻā§āϞ⧠āĻĻā§āĻā§āĻž āĻšāϞā§:
|
||
|
||
- ā§§ā§Ļā§Ļ% āĻāĻĒā§āύ āϏā§āϰā§āϏ
|
||
- āĻā§āύ⧠āĻĒā§āϰā§āĻāĻžāĻāĻĄāĻžāϰā§āϰ āϏāĻžāĻĨā§ āĻāĻŦāĻĻā§āϧ āύā§āĨ¤ āϝāĻĻāĻŋāĻ āĻāĻŽāϰāĻž [OpenCode Zen](https://opencode.ai/zen) āĻāϰ āĻŽāĻžāϧā§āϝāĻŽā§ āĻŽāĻĄā§āϞāϏāĻŽā§āĻš āĻŦā§āϝāĻŦāĻšāĻžāϰā§āϰ āĻĒāϰāĻžāĻŽāϰā§āĻļ āĻĻāĻŋāĻ, OpenCode āĻā§āϞāĻĄ (Claude), āĻāĻĒā§āύāĻāĻāĻ (OpenAI), āĻā§āĻāϞ (Google), āĻ
āĻĨāĻŦāĻž āϞā§āĻāĻžāϞ āĻŽāĻĄā§āϞāĻā§āϞā§āϰ āϏāĻžāĻĨā§āĻ āĻŦā§āϝāĻŦāĻšāĻžāϰ āĻāϰāĻž āϝā§āϤ⧠āĻĒāĻžāϰā§āĨ¤ āϝā§āĻŽāύ āϝā§āĻŽāύ āĻŽāĻĄā§āϞāĻā§āϞ⧠āĻāύā§āύāϤ āĻšāĻŦā§, āϤāĻžāĻĻā§āϰ āĻŽāϧā§āϝāĻāĻžāϰ āĻĒāĻžāϰā§āĻĨāĻā§āϝ āĻāĻŽā§ āĻāϏāĻŦā§ āĻāĻŦāĻ āĻĻāĻžāĻŽāĻ āĻāĻŽāĻŦā§, āϤāĻžāĻ āĻĒā§āϰā§āĻāĻžāĻāĻĄāĻžāϰ-āĻ
āĻā§āĻāĻžāϏā§āĻāĻŋāĻ āĻšāĻā§āĻž āĻā§āĻŦāĻ āĻā§āϰā§āϤā§āĻŦāĻĒā§āϰā§āĻŖāĨ¤
|
||
- āĻāĻāĻ-āĻ
āĻĢ-āĻĻā§āϝ-āĻŦāĻā§āϏ LSP āϏāĻžāĻĒā§āϰā§āĻ
|
||
- TUI āĻāϰ āĻāĻĒāϰ āĻĢā§āĻāĻžāϏāĨ¤ OpenCode āύāĻŋāĻāĻāĻŋāĻŽ (neovim) āĻŦā§āϝāĻŦāĻšāĻžāϰāĻāĻžāϰ⧠āĻāĻŦāĻ [terminal.shop](https://terminal.shop) āĻāϰ āύāĻŋāϰā§āĻŽāĻžāϤāĻžāĻĻā§āϰ āĻĻā§āĻŦāĻžāϰāĻž āϤā§āϰāĻŋ; āĻāĻŽāϰāĻž āĻāĻžāϰā§āĻŽāĻŋāύāĻžāϞ⧠āĻā§ āĻā§ āϏāĻŽā§āĻāĻŦ āϤāĻžāϰ āϏā§āĻŽāĻžāĻŦāĻĻā§āϧāϤāĻž āĻāĻžā§āĻŋā§ā§ āϝāĻžāĻā§āĻžāϰ āĻā§āώā§āĻāĻž āĻāϰāĻāĻŋāĨ¤
|
||
- āĻā§āϞāĻžāϝāĻŧā§āύā§āĻ/āϏāĻžāϰā§āĻāĻžāϰ āĻāϰā§āĻāĻŋāĻā§āĻāĻāĻžāϰāĨ¤ āĻāĻāĻŋ āϝā§āĻŽāύ OpenCode āĻā§ āĻāĻĒāύāĻžāϰ āĻāĻŽā§āĻĒāĻŋāĻāĻāĻžāϰ⧠āĻāĻžāϞāĻžāύā§āϰ āϏā§āϝā§āĻ āĻĻā§ā§, āϤā§āĻŽāύāĻŋ āĻāĻĒāύāĻŋ āĻŽā§āĻŦāĻžāĻāϞ āĻ
ā§āϝāĻžāĻĒ āĻĨā§āĻā§ āϰāĻŋāĻŽā§āĻāϞāĻŋ āĻāĻāĻŋ āύāĻŋā§āύā§āϤā§āϰāĻŖ āĻāϰāϤ⧠āĻĒāĻžāϰāĻŦā§āύ, āĻ
āϰā§āĻĨāĻžā§ TUI āĻĢā§āϰāύā§āĻāĻāύā§āĻĄ āĻā§āĻŦāϞ āϏāĻŽā§āĻāĻžāĻŦā§āϝ āĻā§āϞāĻžāϝāĻŧā§āύā§āĻāĻā§āϞā§āϰ āĻŽāϧā§āϝ⧠āĻāĻāĻāĻŋāĨ¤
|
||
|
||
---
|
||
|
||
**āĻāĻŽāĻžāĻĻā§āϰ āĻāĻŽāĻŋāĻāύāĻŋāĻāĻŋāϤ⧠āϝā§āĻā§āϤ āĻšā§āύ** [Discord](https://discord.gg/opencode) | [X.com](https://x.com/opencode)
|