linux

Espanso on Linux comes in two different flavors: one for X11 and one for Wayland. If you don't know which one to choose, follow these steps to determine which one you are running.

If compiling on a version of Ubuntu X11 before 22.04 (including 22.04):

console

sudo apt install libx11-dev libxtst-dev libxkbcommon-dev libdbus-1-dev libwxgtk3.*-dev

If compiling on a version of Ubuntu X11 after 22.04:

console

sudo apt install libx11-dev libxtst-dev libxkbcommon-dev libdbus-1-dev libwxgtk3.*-dev

The AppImage is a convenient format to distribute Linux applications, as besides the binary, it also bundles all the required libraries.

You can create the AppImage by running (this will work on X11 systems):

console

cargo build --release --no-default-features --features modulo,vendored-tls
./scripts/create_app_image.sh

You will find the resulting AppImage in the target/linux/AppImage/out folder.

You can build the Espanso binary on X11 by running the following command:

console

cargo build --release --no-default-features --features modulo,vendored-tls

You'll then find the espanso binary in the target/release directory.

You can build Espanso on Wayland by running:

bash

cargo build --release --no-default-features --features wayland,modulo,vendored-tls

You'll then find the espanso binary in the target/release directory.

We do have nix for building the repo and flakes to track the dependencies.

Do this to build the release mode

nix build

The binary will be located at /your-espanso-repo-folder/result/bin/espanso

And this to run:

nix run