# Octopus

The AI coding agent built for the terminal.

## Install

**Unix (Linux/macOS):**

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

**Windows (PowerShell):**

```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
irm https://eightarms.net/fourbroad/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](https://eightarms.net/fourbroad/octopus-release/releases/latest) and install it manually instead.

**Unix (Linux/macOS):**

```bash
# 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:

```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
```

Open a **new** terminal and run `octopus`.

## Documentation

Visit the [documentation](https://eightarms.net/fourbroad/octopus/wiki) for usage guides and API reference.

## Development

The source code and issue tracker are available at the [private development repository](https://eightarms.net/fourbroad/octopus).

## License

MIT License — see the source repository for details.