diff --git a/README.md b/README.md index fa15e47..28c5742 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ The AI coding agent built for the terminal. +English | [简体中文](README.zh-CN.md) + ## Install **Unix (Linux/macOS):** @@ -66,11 +68,7 @@ Prefer a GUI? The Octopus desktop app ships Windows and Linux beta builds alongs ## Documentation -Read the workflow overview (in Chinese): [docs/workflow.zh.md](docs/workflow.zh.md) — how Octopus organizes ticket-driven agent work, with links into the guides shipped in this repo. - -## Workflow - -Curious how Octopus organizes agent work? Read about the **ticket-driven workflow system** (in Chinese): [docs/workflow.zh.md](docs/workflow.zh.md) +Curious how Octopus organizes agent work? Read the workflow overview (in Chinese): [docs/workflow.zh.md](docs/workflow.zh.md) — the ticket-driven workflow system, with links into the guides shipped in this repo. ## Development diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..a550cd8 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,84 @@ +# Octopus + +为终端而生的 AI 编程代理。 + +[English](README.md) | 简体中文 + +## 安装 + +**Unix(Linux/macOS):** + +```bash +curl -fsSL https://eightarms.net/Octopus/octopus-release/raw/branch/main/install | bash +``` + +**Windows(PowerShell):** + +```powershell +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +irm https://eightarms.net/Octopus/octopus-release/raw/branch/main/install.ps1 | iex +``` + +### 手动安装 + +若一键脚本报连接错误,说明你的网络可能过滤了到 `eightarms.net` 的直连。请从 +[releases 页面](https://eightarms.net/Octopus/octopus-release/releases/latest) 下载对应平台的压缩包手动安装。 + +**Unix(Linux/macOS):** + +```bash +# 从 releases 页面下载 octopus-.tar.gz 后 +tar -xzf octopus-linux-x64.tar.gz +sudo mv octopus /usr/local/bin/ +octopus --version +``` + +**Windows(PowerShell):** 下载 `octopus-windows-x64.zip` 后: + +```powershell +$zip = "$env:USERPROFILE\Downloads\octopus-windows-x64.zip" +$dest = "$env:USERPROFILE\.octopus\bin" +$tmp = Join-Path $env:TEMP "octopus_manual" +New-Item -ItemType Directory -Force -Path $dest,$tmp | Out-Null +Expand-Archive -Path $zip -DestinationPath $tmp -Force +Copy-Item "$tmp\octopus.exe" "$dest\octopus.exe" -Force +Remove-Item -Recurse -Force $tmp +$p = [Environment]::GetEnvironmentVariable('Path','User') +if ($p -notlike "*$dest*") { [Environment]::SetEnvironmentVariable('Path', ($p.TrimEnd(';') + ";$dest"), 'User') } +& "$dest\octopus.exe" --version +``` + +然后打开一个**新**终端运行 `octopus`。 + +## 桌面版(beta) + +偏好图形界面?Octopus 桌面应用与 CLI 一同发布 Windows / Linux beta 构建: + +- **Windows:** 从 [`desktop-beta` 频道](https://eightarms.net/Octopus/octopus-release/releases/tag/desktop-beta) 下载 + [`octopus-desktop-win-x64.exe`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-win-x64.exe) + 安装;已安装的构建会从同一频道自动更新。 +- **Linux (x86_64):** 从同一 [`desktop-beta` 频道](https://eightarms.net/Octopus/octopus-release/releases/tag/desktop-beta) 下载 + [`octopus-desktop-linux-x86_64.AppImage`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-linux-x86_64.AppImage),赋权后运行: + + ```bash + chmod +x octopus-desktop-linux-x86_64.AppImage + ./octopus-desktop-linux-x86_64.AppImage + ``` + + AppImage 自动更新(`latest-linux.yml`)。需要原生包?同频道另有 + [`octopus-desktop-linux-amd64.deb`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-linux-amd64.deb) / + [`octopus-desktop-linux-x86_64.rpm`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-linux-x86_64.rpm)(仅限首装、不自动更新,且未签名会触发首次安装警告)。 + +- 这是 beta 频道,会有粗糙之处;macOS 构建在计划中但尚未发布。 + +## 文档 + +工作流总览:[docs/workflow.zh.md](docs/workflow.zh.md) —— 介绍 Octopus 如何组织工单驱动的代理工作,并链接到仓库内的其他指南。 + +## 开发 + +源码与 issue 跟踪在[私有开发仓库](https://eightarms.net/Octopus/octopus)。 + +## 许可证 + +MIT 许可证 —— 详情见源码仓库。