Skip to content

Installation

Pre-built

Download the latest release (Linux, macOS) and extract it into /:

bash
tar xvf *.tar.xz -C /
tar xvf *.tar.xz -C /

Manual Compilation

Prerequisites

  • A 64-bit Linux distro (it is possible to modify the build.sh file to compile for other platforms, but it may not work as expected)
  • .NET 8 SDK

Steps

Start by cloning the repository:

shell
git clone https://github.com/PaddiM8/elk
cd elk
git clone https://github.com/PaddiM8/elk
cd elk

Compile and install the program:

shell
./build.sh
mkdir -p /usr/share/elk
install -D ./build/* /usr/share/elk/
ln -s /usr/share/elk/elk /usr/bin/elk
./build.sh
mkdir -p /usr/share/elk
install -D ./build/* /usr/share/elk/
ln -s /usr/share/elk/elk /usr/bin/elk

Elk is now installed and can be accessed with the elk command.

Default Shell

WARNING

Setting the default shell to a non-posix shell could lead to problems. An alternative is to add elk at the end of your .bashrc or equivalent file.

When making Elk the default shell, first step is to add the path to the Elk binary to /etc/shells. This makes your system aware of the existence of the shell.

After the path has been added to the /etc/shells file, Elk can be made the default shell by running the following command:

shell
chsh -s /usr/bin/elk
chsh -s /usr/bin/elk