Contributing

Thanks for helping improve Athas.

Development Setup

Common Prerequisites

  • Git
  • Rust (via rustup)
  • Node.js 18+ and bun

Platform Setup

Prerequisites

  • Xcode Command Line Tools
  • Rust (via rustup)
  • Node.js 18+ and bun

Install dependencies

shell
# Install Xcode CLI tools
xcode-select --install

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install bun
curl -fsSL https://bun.sh/install | bash

If you encounter issues with Tauri:

shell
brew install pkg-config

Clone and Run

shell
git clone https://github.com/athasdev/athas.git
cd athas
bun install
bun dev

Release Packages

Debian Packages

Athas can build experimental .deb packages from a Linux checkout. The package script wraps Tauri's Linux bundler, adds the CEF runtime resources, and patches the Debian dependency list after the bundle is created.

shell
bun install
bun build:linux:deb

The script must run on Linux. It looks for a CEF distribution containing libcef.so in CEF_PATH, .cache/tauri-cef, ~/.cache/tauri-cef, ~/.local/share/cef, or the Cargo build directories. If it cannot find CEF, set CEF_PATH explicitly or run a Linux build once to populate the local cache.

shell
CEF_PATH=/path/to/cef bun build:linux:deb

Preview builds use the same script with the preview config:

shell
bash scripts/release/package-linux-native.sh deb --preview

The resulting .deb file is written to target/release/bundle/deb/.