Octopus

The AI coding agent built for the terminal.

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 a Windows beta build 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.
This is a beta channel — expect rough edges. macOS builds are on the way but not published yet.

Documentation

Visit the documentation for usage guides and API reference.

Workflow

Curious how Octopus organizes agent work? Read about the ticket-driven workflow system (in Chinese): docs/workflow.zh.md

Development

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

License

MIT License — see the source repository for details.

2.6 KiB Raw Permalink Blame History