CLI Pre-compiled Binary
The pre-compiled binary is available on the release page. To install it, the typical workflow is as follows:
- 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.
- Extract the file.
- Optionally, make the binary executable (Linux and MacOS only).
- Put it in a folder registered in your environment variable. It can be run from the folder where you extract the app, but this option is less convenient when dealing with datasets in different folders or storage partitions.
See specific details below:
Available pre-compiled binaries
| Platform | Link | Description |
|---|---|---|
| Linux ARM64 | download | For Linux on ARM64 architecture (uncommon). |
| Linux x86_64 (static) | download | For Linux with old GLIBC version. Common in HPC clusters. Also work on newer Linux but with less optimization. |
| Linux x86_64 | download | For Linux with modern GLIBC version. Most recent Linux distribution, including WSL. |
| MacOS ARM64 | download | For MacOS on Apple M series CPUs. |
| MacOS x86_64 | download | For MacOS on Intel. |
| Windows x86_64 | download | Most Windows devices. It may work on ARM Windows as well. |
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(download). - Dynamically 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(download).
Since version 0.21.3, the CLI binary has also been available for Linux's ARM64 architecture. The file is named segul-Linux-arm64.tar.gz (download).
When installing SEGUL in the Windows Subsystem for Linux (WSL), consider that if your files are large and are stored in the Windows partition, WSL 1 will be 2-3 times faster than WSL 2. If you prefer to use WSL 2, the default option, storing your data in the Linux partition is advisable. Learn more about the differences from Microsoft WSL Guidelines.
If you are not sure which version of SEGUL to use on Linux, check the 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.
You can use the Linux version if your version is glibc 2.17 or higher. You should use the Linux-musl version if your version is older.
We recommend using the dynamically linked executable version if your OS has the supported GLIBC version. The compiler optimizes it more, making it faster than the static binary version. See the Rust platform tier list for more information.
Installing Linux binary
Download the compressed Linux executable
You can download the file from the release page or use wget or curl in your terminal app. The example below is for the dynamically linked executable version. Replace the file name with the version you want to download.
wget https://github.com/hhandika/segul/releases/latest/download/segul-Linux-x86_64.tar.gz
Or using curl:
curl -LJO https://github.com/hhandika/segul/releases/latest/download/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, you can try this step if your terminal app does not recognize the binary.
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
If you already have a PATH registered in your environment variable, put the executable in the folder. If you don't have one, you can create a new folder in your home directory and put the executable in it. Then, add the path to the folder to your PATH variable. To do this, on your terminal, type:
which $SHELL
If it shows bash, add the following line to your .bashrc file or .bash_profile, whichever is available in your system. If it shows zsh, add the line to your .zshrc file.
export PATH=$PATH:/path/to/segul/folder
For example, if you put the SEGUL executable in the ~/bin folder, add the following line to your .bashrc file:
export PATH=$PATH:~/bin
Then, run the following command to apply the changes. Change the file name if you use .zshrc or .bash_profile.
source ~/.bashrc
To check which bash profile file is available in your home directory, you can use the following command:
Make sure you are in your home directory or cd ~. Then, run:
ls -a .
It will show all files in your home directory, including hidden files. Look for .bashrc, .bash_profile, or .zshrc. You can create one if you don't have any of these files.
touch .bashrc
Then, add the export PATH line to the file.
Check the installation
Try to call SEGUL from anywhere in your system:
segul --version
It should show the SEGUL version number.
macOS
For macOS, the executables are available for Intel Macs and Apple ARM M series processors.
- Intel Macs. The file is named
segul-macOS-x86_64.tar.gz(download). - Apple ARM M series CPUs. The file is named
segul-macOS-arm64.tar.gz(download).
Installing MacOS binary
Download the compressed MacOS executable
Similar to the Linux version, you can download the file using wget or curl.
wget https://github.com/hhandika/segul/releases/latest/download/segul-macOS-arm64.tar.gz
Or using curl:
curl -LJO https://github.com/hhandika/segul/releases/latest/download/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, you can try this step if your terminal app does not recognize the binary.
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 the SEGUL executable to the folder. Then, try calling SEGUL from anywhere in your system:
segul --version
It should show the SEGUL version number.
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, you may already have a folder registered in your path variable. Copy the segul executable to the folder instead. For MacOS users, we recommend using iTerm2 or warp for more straightforward navigation in the Terminal.
Windows
This instruction is for running SEGUL native on Windows. If you are using WSL, install the Linux version of the app by following the Linux installation guideline. However, running SEGUL on native Windows is more efficient due to better access to the hardware than the WSL. The installation procedure is similar to that of MacOS or Linux. Remember that the Windows executable is compressed in a zip file. After downloading and extracting the zip file, you will set up 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
Download the compressed Windows executable: segul-Windows-x86_64.zip (download).
Decompress Windows executable
Windows has a built-in feature for zip decompression. 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
Click search and type env. Select Edit the system environment variables. Then, click the Environment Variables... button. Select Path in the System variables section and click the 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
We recommend using a combination of Windows Terminal and PowerShell 7 for easy terminal navigation. The Windows Terminal comes pre-installed on Windows 11 and is available on the Microsoft Store for Windows 10 users.