Install from binary release

This guide explains how to install Vicinae from already built binaries.

Runtime dependencies

The following dependencies must be installed regardless of your installation method. You will find the list of package to install for popular distributions below. If your distribution is not listed, you should normally be able to infer the package names you need from these lists. If you got it to work on your distribution, feel free to contribute your own package list!

pacman -Syu			\
    nodejs			\
    qt6-base		\
    qt6-svg			\
    protobuf		\
    cmark-gfm		\
    layer-shell-qt 	\
    libqalculate 	\
    minizip			\
    qtkeychain-qt6

Install manually

First, download the latest release archive.

You want to grab the vicinae-linux-x86_64-${VERSION}.tar.gz looking file.

Assuming you downloaded it in a folder named vicinae, you can now decompress the archive:

tar xvf vicinae-linux-x86_64-${VERSION}.tar.gz

Try running the binary to make sure everything works:

./bin/vicinae server

# to open the window:
./bin/vicinae

If everything works, you can now install the binaries and extra files to system directories:

cp bin/* /usr/local/bin/
cp -r share/* /usr/local/share/

And now, you should be able to simply run vicinae like so:

vicinae server

# to open the window:
vicinae

Can't load shared library

If you are getting such an error, it means that a library Vicinae needs at runtime could not be found on your system.

Make sure you installed all the dependencies listed above.

You can list all the missing libraries with the following commands:

ldd ./bin/vicinae | grep -i 'not'

If you are unable to find the libraries to install, feel free to open a new issue or come seek help on our Discord server.