Octopus

The AI coding agent built for the terminal.

English | 简体中文

Install

Unix (Linux/macOS):

curl -fsSL https://eightarms.net/Octopus/octopus-release/raw/branch/main/install | bash

Windows (PowerShell):

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
irm https://eightarms.net/Octopus/octopus-release/raw/branch/main/install.ps1 | iex

Manual install

If the one-liner fails with a connection error, the direct connection to eightarms.net is likely being filtered on your network. Download the archive for your platform from the releases page and install it manually instead.

Unix (Linux/macOS):

# after downloading octopus-<platform>.tar.gz from the releases page
tar -xzf octopus-linux-x64.tar.gz
sudo mv octopus /usr/local/bin/
octopus --version

Windows (PowerShell):

After downloading octopus-windows-x64.zip from the releases page:

$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

Open a new terminal and run octopus.

Desktop (beta)

Prefer a GUI? The Octopus desktop app ships Windows and Linux beta builds alongside the CLI:

Windows: download octopus-desktop-win-x64.exe from the desktop-beta channel and run the installer. Installed builds auto-update themselves from the same channel.
Linux (x86_64): download octopus-desktop-linux-x86_64.AppImage from the same desktop-beta channel, make it executable and run it:
```
chmod +x octopus-desktop-linux-x86_64.AppImage
./octopus-desktop-linux-x86_64.AppImage
```
The AppImage auto-updates itself from the same channel (latest-linux.yml). Prefer a native package? octopus-desktop-linux-amd64.deb and octopus-desktop-linux-x86_64.rpm are published on the same channel for first installs only — they do not auto-update (reinstall or switch to the AppImage for updates), and being unsigned they will trip a first-install warning on apt/dnf.
macOS (Apple Silicon): download octopus-desktop-mac-arm64.dmg from the same desktop-beta channel, open it and drag Octopus Beta to Applications. The app is Developer ID signed and notarized — Gatekeeper opens it without warnings. Auto-updates from the same channel (latest-mac.yml).
This is a beta channel — expect rough edges.

Documentation

Curious how Octopus organizes agent work? Read the workflow overview (in Chinese): docs/workflow.zh.md — the ticket-driven workflow system, with links into the guides shipped in this repo.

Development

The source code and issue tracker are available at the private development repository.

License

MIT License — see the source repository for details.