From daa3ecb842f89b2b130661c3fc1f33fb3cadc82d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E4=B8=AD=E6=B4=8B?= Date: Fri, 5 Jun 2026 14:20:19 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20README.zh.md=20=E6=94=B9=E5=86=99?= =?UTF-8?q?=E4=B8=BA=20zmo=20=E5=93=81=E7=89=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 更新介绍、安装方式、配置说明、链接为 zmo，标注基于 OpenCode(MIT) 二开。 Co-Authored-By: Claude Opus 4.7 --- README.zh.md | 138 ++++++++++++++++++++++----------------------------- 1 file changed, 58 insertions(+), 80 deletions(-) diff --git a/README.zh.md b/README.zh.md index 93f81e83c..14f73d208 100644 --- a/README.zh.md +++ b/README.zh.md @@ -1,105 +1,57 @@

- - - - - OpenCode logo - + + zmo logo

-

开源的 AI Coding Agent。

+

开源的 AI Coding Agent，运行在你的终端里。

- Discord - npm - Build status + repo + license

English | - 简体中文 | - 繁體中文 | - 한국어 | - Deutsch | - Español | - Français | - Italiano | - Dansk | - 日本語 | - Polski | - Русский | - Bosanski | - العربية | - Norsk | - Português (Brasil) | - ไทย | - Türkçe | - Українська | - বাংলা | - Ελληνικά | - Tiếng Việt + 简体中文

-[![OpenCode Terminal UI](packages/web/src/assets/lander/screenshot.png)](https://opencode.ai) +--- + +> **zmo** 是一个基于开源项目 [OpenCode](https://github.com/anomalyco/opencode)（MIT 许可）二次开发的、聚焦终端的 AI 编码助手 CLI。它保留了 OpenCode 的核心 Agent 能力（自主任务、工具调用、LSP、MCP、权限系统、多模型适配），并精简为纯命令行体验。 --- ### 安装 +> [!NOTE] +> 以下软件包管理器渠道为**正式发布后**的目标安装方式。在正式发布前，请使用文末「从源码构建」一节的方法。 + ```bash # 直接安装 (YOLO) -curl -fsSL https://opencode.ai/install | bash +curl -fsSL https://git.chatbot.js.cn/lmin/zmo-cli/install | bash # 软件包管理器 -npm i -g opencode-ai@latest # 也可使用 bun/pnpm/yarn -scoop install opencode # Windows -choco install opencode # Windows -brew install anomalyco/tap/opencode # macOS 和 Linux（推荐，始终保持最新） -brew install opencode # macOS 和 Linux（官方 brew formula，更新频率较低） -sudo pacman -S opencode # Arch Linux (Stable) -paru -S opencode-bin # Arch Linux (Latest from AUR) -mise use -g opencode # 任意系统 -nix run nixpkgs#opencode # 或用 github:anomalyco/opencode 获取最新 dev 分支 +npm i -g zmo@latest # 也可使用 bun/pnpm/yarn +scoop install zmo # Windows +choco install zmo # Windows +brew install zmo # macOS 和 Linux +mise use -g zmo # 任意系统 ``` > [!TIP] -> 安装前请先移除 0.1.x 之前的旧版本。 - -### 桌面应用程序 (BETA) - -OpenCode 也提供桌面版应用。可直接从 [发布页 (releases page)](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` 或 AppImage | - -```bash -# macOS (Homebrew Cask) -brew install --cask opencode-desktop -# Windows (Scoop) -scoop bucket add extras; scoop install extras/opencode-desktop -``` +> 安装后，在任意项目目录运行 `zmo` 即可启动交互式 TUI，或运行 `zmo run "你的需求"` 直接执行单次任务。 #### 安装目录 安装脚本按照以下优先级决定安装路径： -1. `$OPENCODE_INSTALL_DIR` - 自定义安装目录 +1. `$ZMO_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 -``` +4. `$HOME/.zmo/bin` - 默认备用路径 ### Agents -OpenCode 内置两种 Agent，可用 `Tab` 键快速切换： +zmo 内置两种 Agent，可用 `Tab` 键快速切换： - **build** - 默认模式，具备完整权限，适合开发工作 - **plan** - 只读模式，适合代码分析与探索 @@ -109,20 +61,46 @@ OpenCode 内置两种 Agent，可用 `Tab` 键快速切换： 另外还包含一个 **general** 子 Agent，用于复杂搜索和多步任务，内部使用，也可在消息中输入 `@general` 调用。 -了解更多 [Agents](https://opencode.ai/docs/agents) 相关信息。 +### 配置 -### 文档 +zmo 在项目根目录或 `~/.config/zmo/` 下读取配置文件，支持以下文件名（按优先级）： -更多配置说明请查看我们的 [**官方文档**](https://opencode.ai/docs)。 +- `config.json` +- `zmo.json` / `zmo.jsonc` +- `opencode.json` / `opencode.jsonc`（向下兼容） + +环境变量同时支持 `ZMO_*`（优先）与 `OPENCODE_*`（向下兼容）两种前缀。 + +### 从源码构建（当前推荐） + +在正式发布渠道上线前，可通过源码自行构建单文件可执行程序： + +```bash +# 1. 克隆仓库 +git clone https://git.chatbot.js.cn/lmin/zmo-cli.git +cd zmo-cli + +# 2. 安装依赖（需 Bun 1.3+） +bun install + +# 3. 构建当前平台的单二进制 +cd packages/opencode +bun run build --single --skip-embed-web-ui + +# 4. 产物位于 packages/opencode/dist/<平台>/bin/zmo +# 将其加入 PATH 即可全局使用 zmo 命令 +``` + +也可在不构建的情况下直接运行（开发模式）： + +```bash +bun run dev # 在仓库根目录 +``` ### 参与贡献 -如有兴趣贡献代码，请在提交 PR 前阅读 [贡献指南 (Contributing Docs)](./CONTRIBUTING.md)。 +如有兴趣贡献代码，请在提交 PR 前阅读 [贡献指南](./CONTRIBUTING.md)。 -### 基于 OpenCode 进行开发 +### 致谢 -如果你在项目名中使用了 “opencode”（如 “opencode-dashboard” 或 “opencode-mobile”），请在 README 里注明该项目不是 OpenCode 团队官方开发，且不存在隶属关系。 - ---- - -**加入我们的社区** [飞书](https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=738j8655-cd59-4633-a30a-1124e0096789&qr_code=true) | [X.com](https://x.com/opencode) +zmo 基于 [OpenCode](https://github.com/anomalyco/opencode)（MIT License）二次开发，感谢原项目作者与社区。本项目与 OpenCode 官方团队无隶属关系。