|
| 1 | +<p align="center"> |
| 2 | + <a href="https://opencode.ai"> |
| 3 | + <picture> |
| 4 | + <source srcset="packages/console/app/src/asset/logo-ornate-dark.svg" media="(prefers-color-scheme: dark)"> |
| 5 | + <source srcset="packages/console/app/src/asset/logo-ornate-light.svg" media="(prefers-color-scheme: light)"> |
| 6 | + <img src="packages/console/app/src/asset/logo-ornate-light.svg" alt="OpenCode logo"> |
| 7 | + </picture> |
| 8 | + </a> |
| 9 | +</p> |
| 10 | +<p align="center">开源的 AI Coding Agent。</p> |
| 11 | +<p align="center"> |
| 12 | + <a href="https://opencode.ai/discord"><img alt="Discord" src="https://img.shields.io/discord/1391832426048651334?style=flat-square&label=discord" /></a> |
| 13 | + <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> |
| 14 | + <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> |
| 15 | +</p> |
| 16 | + |
| 17 | +[](https://opencode.ai) |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +### 安装 |
| 22 | + |
| 23 | +```bash |
| 24 | +# 直接安装 (YOLO) |
| 25 | +curl -fsSL https://opencode.ai/install | bash |
| 26 | + |
| 27 | +# 软件包管理器 |
| 28 | +npm i -g opencode-ai@latest # 也可使用 bun/pnpm/yarn |
| 29 | +scoop bucket add extras; scoop install extras/opencode # Windows |
| 30 | +choco install opencode # Windows |
| 31 | +brew install anomalyco/tap/opencode # macOS 和 Linux(推荐,始终保持最新) |
| 32 | +brew install opencode # macOS 和 Linux(官方 brew formula,更新频率较低) |
| 33 | +paru -S opencode-bin # Arch Linux |
| 34 | +mise use -g opencode # 任意系统 |
| 35 | +nix run nixpkgs#opencode # 或用 github:anomalyco/opencode 获取最新 dev 分支 |
| 36 | +``` |
| 37 | + |
| 38 | +> [!TIP] |
| 39 | +> 安装前请先移除 0.1.x 之前的旧版本。 |
| 40 | +
|
| 41 | +### 桌面应用程序 (BETA) |
| 42 | + |
| 43 | +OpenCode 也提供桌面版应用。可直接从 [发布页 (releases page)](https://github.com/anomalyco/opencode/releases) 或 [opencode.ai/download](https://opencode.ai/download) 下载。 |
| 44 | + |
| 45 | +| 平台 | 下载文件 | |
| 46 | +| --------------------- | ------------------------------------- | |
| 47 | +| macOS (Apple Silicon) | `opencode-desktop-darwin-aarch64.dmg` | |
| 48 | +| macOS (Intel) | `opencode-desktop-darwin-x64.dmg` | |
| 49 | +| Windows | `opencode-desktop-windows-x64.exe` | |
| 50 | +| Linux | `.deb`、`.rpm` 或 AppImage | |
| 51 | + |
| 52 | +```bash |
| 53 | +# macOS (Homebrew Cask) |
| 54 | +brew install --cask opencode-desktop |
| 55 | +``` |
| 56 | + |
| 57 | +#### 安装目录 |
| 58 | + |
| 59 | +安装脚本按照以下优先级决定安装路径: |
| 60 | + |
| 61 | +1. `$OPENCODE_INSTALL_DIR` - 自定义安装目录 |
| 62 | +2. `$XDG_BIN_DIR` - 符合 XDG 基础目录规范的路径 |
| 63 | +3. `$HOME/bin` - 如果存在或可创建的用户二进制目录 |
| 64 | +4. `$HOME/.opencode/bin` - 默认备用路径 |
| 65 | + |
| 66 | +```bash |
| 67 | +# 示例 |
| 68 | +OPENCODE_INSTALL_DIR=/usr/local/bin curl -fsSL https://opencode.ai/install | bash |
| 69 | +XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash |
| 70 | +``` |
| 71 | + |
| 72 | +### Agents |
| 73 | + |
| 74 | +OpenCode 内置两种 Agent,可用 `Tab` 键快速切换: |
| 75 | + |
| 76 | +- **build** - 默认模式,具备完整权限,适合开发工作 |
| 77 | +- **plan** - 只读模式,适合代码分析与探索 |
| 78 | + - 默认拒绝修改文件 |
| 79 | + - 运行 bash 命令前会询问 |
| 80 | + - 便于探索未知代码库或规划改动 |
| 81 | + |
| 82 | +另外还包含一个 **general** 子 Agent,用于复杂搜索和多步任务,内部使用,也可在消息中输入 `@general` 调用。 |
| 83 | + |
| 84 | +了解更多 [Agents](https://opencode.ai/docs/agents) 相关信息。 |
| 85 | + |
| 86 | +### 文档 |
| 87 | + |
| 88 | +更多配置说明请查看我们的 [**官方文档**](https://opencode.ai/docs)。 |
| 89 | + |
| 90 | +### 参与贡献 |
| 91 | + |
| 92 | +如有兴趣贡献代码,请在提交 PR 前阅读 [贡献指南 (Contributing Docs)](./CONTRIBUTING.md)。 |
| 93 | + |
| 94 | +### 基于 OpenCode 进行开发 |
| 95 | + |
| 96 | +如果你在项目名中使用了 “opencode”(如 “opencode-dashboard” 或 “opencode-mobile”),请在 README 里注明该项目不是 OpenCode 团队官方开发,且不存在隶属关系。 |
| 97 | + |
| 98 | +### 常见问题 (FAQ) |
| 99 | + |
| 100 | +#### 这和 Claude Code 有什么不同? |
| 101 | + |
| 102 | +功能上很相似,关键差异: |
| 103 | + |
| 104 | +- 100% 开源。 |
| 105 | +- 不绑定特定提供商。推荐使用 [OpenCode Zen](https://opencode.ai/zen) 的模型,但也可搭配 Claude、OpenAI、Google 甚至本地模型。模型迭代会缩小差异、降低成本,因此保持 provider-agnostic 很重要。 |
| 106 | +- 内置 LSP 支持。 |
| 107 | +- 聚焦终端界面 (TUI)。OpenCode 由 Neovim 爱好者和 [terminal.shop](https://terminal.shop) 的创建者打造,会持续探索终端的极限。 |
| 108 | +- 客户端/服务器架构。可在本机运行,同时用移动设备远程驱动。TUI 只是众多潜在客户端之一。 |
| 109 | + |
| 110 | +#### 另一个同名的仓库是什么? |
| 111 | + |
| 112 | +另一个名字相近的仓库与本项目无关。[点击这里了解背后故事](https://x.com/thdxr/status/1933561254481666466)。 |
| 113 | + |
| 114 | +--- |
| 115 | + |
| 116 | +**加入我们的社区** [Discord](https://discord.gg/opencode) | [X.com](https://x.com/opencode) |
0 commit comments