Skip to content

Installation

Install the latest build for the current operating system and architecture:

curl -fsSL https://raw.githubusercontent.com/luckeyfaraday/athena-code/main/scripts/install.sh | bash

The installer verifies the release checksum, copies the executable to ~/.local/share/athena-code/bin/athena-code, and creates ~/.local/bin/athena-code. The installed command does not depend on a cloned repository.

Install a specific version:

curl -fsSL https://raw.githubusercontent.com/luckeyfaraday/athena-code/main/scripts/install.sh |
bash -s -- --version v0.2.1

See GitHub Releases for available versions, archives, checksums, and release notes.

Run in PowerShell:

irm https://raw.githubusercontent.com/luckeyfaraday/athena-code/main/scripts/install.ps1 | iex

The installer verifies the release checksum, installs athena-code.exe under %LOCALAPPDATA%\AthenaCode, and adds its bin directory to your user PATH.

Installed builds check GitHub Releases in the background on startup and can prompt you to update inside the app. You can also update from the command line:

athena-code upgrade # latest release
athena-code upgrade v0.2.1 # specific version

Set "autoupdate": false in the global config to disable startup checks, or "autoupdate": "notify" to show notifications without automatically installing updates.

Requirements:

  • A supported Linux, macOS, or Windows host
  • Git
  • Node.js with npx
  • At least 5 GB of free temporary disk space
  • Visual Studio 2022 Build Tools with Desktop development with C++ on Windows
git clone https://github.com/luckeyfaraday/athena-code.git
cd athena-code
./scripts/build.sh

The build checks out the pinned OpenCode revision, applies Athena Code’s patch and source overlay, installs dependencies, and writes the executable to runtime-bin/<platform>-<architecture>/.

Install a local Linux or macOS build by passing its generated path:

./scripts/install.sh --from-file ./runtime-bin/linux-x64/athena-code

On Windows:

.\scripts\install.ps1 -FromFile .\runtime-bin\windows-x64\athena-code.exe

The repository maintains a reproducible fork rather than vendoring the entire upstream source tree:

OpenCode pinned revision
+
patches/opencode-athena.patch
+
overlay/packages/opencode/...
=
runtime-bin/<platform>-<architecture>/athena-code
PathContents
overlay/Athena-owned memory, recall, tools, and TUI source
patches/Integration and branding changes applied to OpenCode
scripts/build.shReproducible source build
scripts/install.shLinux and macOS installer
scripts/install.ps1Windows PowerShell installer
test/Memory, recall, snapshot, and session-index tests
docs/Technical design documentation