Skip to main content

CLI Pre-compiled Binary

The pre-compiled binary is available in the release page. To install it, the typical workflow is as follow:

  1. Download the compressed executable file (.zip or .tar.gz) in the release page to your computer, either using a browser or using a command line app.
  2. Extract the file.
  3. Optionally, make the binary executable (Linux and MacOS only).
  4. Put it in a folder registered in your environment variable. It can be run from the folder where you extract the app too, but this option is less convenient when dealing with datasets in different folders or storage partitions.

See specific details below:

Linux/WSL​

SEGUL is highly optimized to be as fast and efficient as possible. For this reason, we provide two versions of the app for Linux:

  • Fully static executable using musl libc. This version is suitable for running the app on old Linux distributions or some HPC systems. The file is named segul-Linux-musl-x86_64.tar.gz.
  • Dinamically linked executable using glibc. This version is suitable for running the app on modern Linux distributions. The file is named segul-Linux-x86_64.tar.gz.

Check GLIBC version:

ldd --version

Output example:

# ldd (Ubuntu GLIBC 2.35-0ubuntu3.1) 2.35
# Copyright (C) 2022 Free Software Foundation, Inc.
# This is free software; see the source for copying conditions.  There is NO
# warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# Written by Roland McGrath and Ulrich Drepper.

If your version is glibc 2.17+, you can use the version labeled Linux. If your version is older, you should use the version labeled Linux-musl.

info

We recommend using the dynamically linked executable version if your OS has the supported GLIBC version. It is more optimized by the compiler, which in theory will be faster than the static binary version. See Rust platform tier list for more information.

Installing Linux binary​

Download the compressed Linux executable​

Here, we use the version 0.20.2 as an example. You should replace the link with the most up to date version available in the release page.

wget https://github.com/hhandika/segul/releases/download/v0.20.2/segul-Linux-x86_64.tar.gz

Using curl:

curl -LJO https://github.com/hhandika/segul/releases/download/v0.20.2/segul-Linux-x86_64.tar.gz

Decompress Linux executable​

tar xfvz segul-Linux-x86_64.tar.gz

Make the binary executable for Linux (optional)​

It may not be necessary. However, if your terminal app does not recognize the binary, you can try this step.

chmod +x segul

If you would like the binary executable for all users:

chmod a+x segul

Put it in a folder registered in your Linux PATH variable​

Copy SEGUL executable to the folder. Then, try call SEGUL from anywhere in your system:

segul --version

macOS​

For macOS, the executables are available for Intel Macs and Apple ARM M series processor.

  • Intel Macs. The file is named segul-macOS-x86_64.tar.gz.
  • Apple ARM M series CPUs. The file is named segul-macOS-arm64.tar.gz.

Installing MacOS binary​

Download the compressed MacOS executable​

Here, we use the version 0.20.2 for Apple ARM processors as an example. You should replace the link with the most up to date version available in the release page.


wget https://github.com/hhandika/segul/releases/download/v0.20.2/segul-macOS-arm64.tar.gz

Using curl:

curl -LJO https://github.com/hhandika/segul/releases/download/v0.20.2/segul-macOS-arm64.tar.gz

Decompress MacOS executable​

tar xfvz segul-macOS-arm64.tar.gz

Make the binary executable for MacOS (optional)​

This step may not be necessary. However, if your terminal app does not recognize the binary, you can try this step.

chmod +x segul

If you would like the binary executable for all users:

chmod a+x segul

Put it in a folder registered in your macOS PATH variable​

Recent macOS versions use zsh as the default shell. If you are using zsh, you can add the path to the folder where you put the SEGUL executable to your PATH variable by adding the following line to your .zshrc file:

export PATH=$PATH:/path/to/segul/folder

Copy SEGUL executable to the folder. Then, try call SEGUL from anywhere in your system:

segul --version

It should show the SEGUL version number.

tip

It is best to avoid registering too many paths in your environment variable. It will slow down your terminal startup. If you already used a single executable cli app, the chance is that you may already have a folder registered in your path variable. Copy segul executable to the folder instead. For MacOS users, we recommend using iTerm2 or warp for easier navigation in the Terminal.

Windows​

This instruction is for running SEGUL native on Windows. If you are using WSL, you install the Linux version of the app by following the instruction above. However, running SEGUL on native Windows is more efficient due to a better access to the hardware than the WSL. The installation procedure is similar to the MacOS or Linux. After downloading the zip file for Windows and extracting it, you will setup your environment variable pointing to the path where you will put the executable. In Windows, this is usually done using GUI.

Installing Windows binary​

Download segul-Windows-x86_64.zip​

Use your browser to download the file from the release page.

Decompress Windows executable​

Windows has a built-in zip decompressor. You can right-click the file and select Extract All... from the context menu. You can also use third-party apps like 7zip.

After decompressing the file, you will find the segul.exe file. You can put it in a folder registered in your environment variable. Create a new folder if you don't have one yet. Then, put the segul.exe file in the folder.

Setup the environment variable (optional)​

Click search and type env. Select Edit the system environment variables. Then, click Environment Variables... button. In the System variables section, select Path and click Edit... button. Click New and add the path to the folder where you put the SEGUL executable. Click OK to close the dialog boxes.

  • Open a new terminal and try to call SEGUL from anywhere in your system:
segul --version
tip

We recommend using a combination of Windows Terminal and PowerShell 7 for easy navigation in the terminal. Windows terminal comes pre-installed on Windows 11. It is available on Microsoft Store for Windows 10 users. You can also use Windows Subsystem for Linux (WSL) to run the Linux version of SEGUL. Follow the Linux/WSL installation guideline for installing the Linux binary on WSL. Keep in mind that, if your data is big and it is in the Windows partition, WSL 1 will be 2-3 times faster than WSL 2. If you are using WSL 2, you should put your data in the Linux partition. Learn more about WSL here.