Installation

Choose the installation method for your platform. We recommend using Homebrew on macOS for the easiest setup and updates.

macOS

Homebrew (Recommended)

The easiest way to install on macOS. Homebrew will handle updates automatically.

brew install cooklang/tap/cook-sync

DMG Installer

Download the DMG from the releases page and drag Cook Sync to your Applications folder.

The DMG version includes Sparkle for automatic updates.

Shell Installer

Run this command in Terminal to download and install:

curl -sSL https://github.com/Cooklang/sync-agent/releases/latest/download/cook-sync-installer.sh | sh

Windows

MSI Installer (Recommended)

Download the MSI installer from the releases page and run it.

PowerShell Installer

Run this command in PowerShell:

irm https://github.com/Cooklang/sync-agent/releases/latest/download/cook-sync-installer.ps1 | iex

Linux

Shell Installer (Recommended)

Run this command in your terminal:

curl -sSL https://github.com/Cooklang/sync-agent/releases/latest/download/cook-sync-installer.sh | sh

AppImage

Download the AppImage from the releases page:

# Download
wget https://github.com/Cooklang/sync-agent/releases/latest/download/cook-sync-x86_64.AppImage

# Make executable
chmod +x cook-sync-*.AppImage

# Run
./cook-sync-*.AppImage start

On first launch, Cook Sync will automatically install desktop integration (menu entry and icons).

System Tray Requirements

The system tray icon requires specific packages depending on your desktop environment:

GNOME Users

Install the AppIndicator extension:

sudo apt install gnome-shell-extension-appindicator
gnome-extensions enable [email protected]

Then restart GNOME Shell (Alt+F2, type 'r', press Enter).

XFCE Users

sudo apt install xfce4-indicator-plugin

Then add the Indicator Plugin to your panel.

KDE/MATE Users

System tray works out of the box - no additional setup needed.

From Source

If you prefer to build from source, you'll need Rust installed:

# Clone the repository
git clone https://github.com/Cooklang/sync-agent.git
cd sync-agent

# Build
cargo build --release

# The binary will be at: target/release/cook-sync
./target/release/cook-sync start

Build Dependencies

Ubuntu/Debian:

sudo apt install libayatana-appindicator3-dev libgtk-3-dev libxdo-dev

Fedora/RHEL:

sudo dnf install libappindicator-gtk3-devel gtk3-devel

Arch Linux:

sudo pacman -S libappindicator-gtk3 gtk3