Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b9270a242c | ||
|
|
74ab30a4f3 | ||
|
|
029031ea75 | ||
|
|
53a9525c42 | ||
|
|
681dcd7b11 |
@@ -51,14 +51,22 @@ Open a **new** terminal and run `octopus`.
|
||||
|
||||
## Desktop (beta)
|
||||
|
||||
Prefer a GUI? The Octopus desktop app ships a Windows beta build alongside the CLI:
|
||||
Prefer a GUI? The Octopus desktop app ships Windows and Linux beta builds alongside the CLI:
|
||||
|
||||
- **Windows:** download [`octopus-desktop-win-x64.exe`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-win-x64.exe) from the [`desktop-beta` channel](https://eightarms.net/Octopus/octopus-release/releases/tag/desktop-beta) and run the installer. Installed builds auto-update themselves from the same channel.
|
||||
- **Linux (x86_64):** download [`octopus-desktop-linux-x86_64.AppImage`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-linux-x86_64.AppImage) from the same [`desktop-beta` channel](https://eightarms.net/Octopus/octopus-release/releases/tag/desktop-beta), make it executable and run it:
|
||||
|
||||
```bash
|
||||
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`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-linux-amd64.deb) and [`octopus-desktop-linux-x86_64.rpm`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/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.
|
||||
- This is a beta channel — expect rough edges. macOS builds are on the way but not published yet.
|
||||
|
||||
## Documentation
|
||||
|
||||
Visit the [documentation](https://eightarms.net/Octopus/octopus/wiki) for usage guides and API reference.
|
||||
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
|
||||
|
||||
|
||||
Executable
+81
@@ -0,0 +1,81 @@
|
||||
# Octopus
|
||||
|
||||
The AI coding agent built for the terminal.
|
||||
|
||||
## Install
|
||||
|
||||
**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
|
||||
```
|
||||
|
||||
### 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/Octopus/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`.
|
||||
|
||||
## 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`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-win-x64.exe) from the [`desktop-beta` channel](https://eightarms.net/Octopus/octopus-release/releases/tag/desktop-beta) and run the installer. Installed builds auto-update themselves from the same channel.
|
||||
- **Linux (x86_64):** download [`octopus-desktop-linux-x86_64.AppImage`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-linux-x86_64.AppImage) from the same [`desktop-beta` channel](https://eightarms.net/Octopus/octopus-release/releases/tag/desktop-beta), make it executable and run it:
|
||||
|
||||
```bash
|
||||
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`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/octopus-desktop-linux-amd64.deb) and [`octopus-desktop-linux-x86_64.rpm`](https://eightarms.net/Octopus/octopus-release/releases/download/desktop-beta/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.
|
||||
- This is a beta channel — expect rough edges. macOS builds are on the way but not published yet.
|
||||
|
||||
## 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)
|
||||
|
||||
## Development
|
||||
|
||||
The source code and issue tracker are available at the [private development repository](https://eightarms.net/Octopus/octopus).
|
||||
|
||||
## License
|
||||
|
||||
MIT License — see the source repository for details.
|
||||
Reference in New Issue
Block a user