Installation Instructions

This section provides instructions on how to install Tomat, a customizable Pomodoro timer.

Install Script

The installer selects the appropriate release binary for Linux or macOS and installs it to ~/.local/bin. If you prefer, download and inspect the script before running it.

curl --proto '=https' --tlsv1.2 -sSf https://jolars.github.io/tomat/install | sh

Set TOMAT_INSTALL_DIR to change the destination, TOMAT_TAG to pin a version, TOMAT_LIBC (gnu or musl) to override Linux libc detection, and TOMAT_VERIFY_CHECKSUM=false to skip checksum verification.

Pre-built Binaries

You can also download a pre-built binary directly from the releases page. Binaries are available for multiple architectures and distributions:

Generic Linux (x86_64, aarch64): glibc and static musl .tar.gz archives
macOS (Intel and Apple Silicon): .tar.gz archives
Debian/Ubuntu: .deb packages
Fedora/RHEL/openSUSE: .rpm packages

The musl archives run without a system C library dependency. Because ALSA is not available in the static build, they support desktop notifications but not audio alerts.

Generic Binary

# Download and install (x86_64)
curl -L https://github.com/jolars/tomat/releases/latest/download/tomat-x86_64-unknown-linux-gnu.tar.gz | tar xz
sudo mv tomat /usr/local/bin/

# Or for ARM64
curl -L https://github.com/jolars/tomat/releases/latest/download/tomat-aarch64-unknown-linux-gnu.tar.gz | tar xz
sudo mv tomat /usr/local/bin/

macOS

# Apple Silicon
curl -L https://github.com/jolars/tomat/releases/latest/download/tomat-aarch64-apple-darwin.tar.gz | tar xz
sudo mv tomat /usr/local/bin/

# Intel
curl -L https://github.com/jolars/tomat/releases/latest/download/tomat-x86_64-apple-darwin.tar.gz | tar xz
sudo mv tomat /usr/local/bin/

Debian/Ubuntu Package

curl -LO https://github.com/jolars/tomat/releases/latest/download/tomat_amd64.deb
sudo dpkg -i tomat_amd64.deb

The DEB package includes the systemd service and shell completions.

RPM Package (Fedora/RHEL/openSUSE)

curl -LO https://github.com/jolars/tomat/releases/latest/download/tomat-x86_64.rpm
sudo rpm -i tomat-x86_64.rpm

The RPM package includes the systemd service and shell completions.

Package Managers

Arch Linux (AUR)

Tomat is available in the AUR as tomat-bin:

# Using your favorite AUR helper
paru -S tomat-bin
# or
yay -S tomat-bin

NixOS

If you are using NixOS, Tomat is available in the official packages:

{
  environment.systemPackages = [
    pkgs.tomat
  ];
}

You still need to set up the systemd service for automatic startup.

Home Manager

But if you’re using home manager, you’re in luck! Tomat is supported as a module:

{
  services.tomat = {
    enable = true;

    settings = {
      timer = {
        work = 25;
        break = 5;
      };
    };
  };
}

Install from Crates.io

You can also install Tomat via Cargo from crates.io. If you don’t have Rust and Cargo installed, follow the instructions at https://www.rust-lang.org/tools/install first to set up your Rust environment.

cargo install tomat

Building from Source

Anoter way to install Tomat is to build it from source. First, clone the repository:

git clone https://github.com/jolars/tomat.git
cd tomat

Prerequisites

On Linux systems, audio notifications require ALSA development libraries. macOS uses Core Audio and needs no additional system package.

# Ubuntu/Debian
sudo apt-get install libasound2-dev

# Fedora/RHEL
sudo dnf install alsa-lib-devel

# Arch Linux
sudo pacman -S alsa-lib

Build and Install

Then, build and install Tomat using Cargo:

cargo install --path .

Note

Audio will be automatically disabled if ALSA is not available. The timer will still work normally, but with desktop notifications only.

Background Service Setup

Tomat can install the native user service—systemd on Linux or a LaunchAgent on macOS—so that the daemon starts automatically on login:

tomat daemon install

On macOS, this command loads and starts the LaunchAgent immediately. You can inspect it with:

launchctl print gui/$UID/io.github.jolars.tomat

On Linux, enable and start the installed systemd service with:

systemctl --user enable tomat.service --now

Alternative Manual Systemd Setup

If you prefer to set up the systemd service manually, you can copy the service file from the examples directory:

# Manual systemd setup (if you prefer)
mkdir -p ~/.config/systemd/user
curl -o ~/.config/systemd/user/tomat.service https://raw.githubusercontent.com/jolars/tomat/main/assets/tomat.service
systemctl --user daemon-reload
systemctl --user enable tomat.service --now

Keyboard shortcuts

Tomat Documentation