Skip to content

CLI Installation

The SEGUL CLI is a single executable named segul. Pick the method that fits your system:

MethodPlatformsBest for
Installer scriptLinux, macOSThe quickest install, no root access needed
Pre-compiled binaryLinux, macOS, Windows, WSLManual installs, Windows, offline machines
CondaLinux, macOSConda users and shared environments
CargoAny platform Rust supportsRust users; builds tuned for your hardware
Source codeAny platform Rust supportsThe latest code, or beta features

After installing, check that segul runs from any folder:

Terminal window
segul --version

On Linux and macOS, run:

Terminal window
curl -fsSL https://segul.app/install.sh | sh

The script picks the right binary for your system and installs it to ~/.local/bin without root access. It tells you if that folder is not on your PATH. On Linux x86_64, it uses the static musl build when your GLIBC is older than 2.34, which is common on HPC clusters.

Pass options after sh -s --, for example curl -fsSL https://segul.app/install.sh | sh -s -- --dir ~/bin.

OptionDescription
--dir <path>Install into another folder, such as --dir ~/bin.
--version <tag>Install a specific release, such as --version v0.23.2.
--muslUse the static Linux build even when GLIBC is new enough.
--uninstallRemove the installed binary. Add --dir if you used a custom folder.

Download the archive for your system from the latest release:

Linux x86_64 comes in two builds. Check your GLIBC version to choose:

Terminal window
ldd --version
  • GLIBC 2.34 or newer: use segul-Linux-x86_64.tar.gz. The compiler optimizes it more, so it is faster.
  • Older GLIBC: use the fully static segul-Linux-musl-x86_64.tar.gz. It runs on any Linux, including older HPC systems.
  • ARM64: use segul-Linux-arm64.tar.gz, available since 0.21.3. It needs GLIBC 2.34 or newer.
  1. Download and extract the archive. Replace the file name with the build you chose.

    Terminal window
    curl -LJO https://github.com/hhandika/segul/releases/latest/download/segul-Linux-x86_64.tar.gz
    tar xfvz segul-Linux-x86_64.tar.gz
  2. If your shell does not recognize the binary, make it executable. Use chmod a+x instead to allow all users.

    Terminal window
    chmod +x segul
  3. Move segul to a folder on your PATH, such as ~/bin. If the folder is not on your PATH yet, add it to your shell profile. Run echo $SHELL to see your shell: use ~/.bashrc (or ~/.bash_profile) for bash and ~/.zshrc for zsh.

    Terminal window
    mkdir -p ~/bin && mv segul ~/bin/
    echo 'export PATH=$PATH:~/bin' >> ~/.bashrc
    source ~/.bashrc
  4. Check the installation with segul --version.

SEGUL is on Bioconda for Linux (x86_64 and ARM64, GLIBC 2.17+) and macOS (Intel and Apple silicon).

With the Bioconda channel set up, install SEGUL with conda or mamba:

Terminal window
conda install bioconda::segul
Terminal window
mamba install segul

If you use Rust, Cargo compiles SEGUL for your hardware and makes updates easy. Install the Rust toolchain, check that it works, then install SEGUL:

Terminal window
cargo --version
cargo install segul

If compiling fails with a linker or build tool error, install the C build tools for your system and try again:

Terminal window
sudo apt install build-essential

Building from source also needs the Rust toolchain.

Install straight from the main branch on GitHub:

Terminal window
cargo install --git https://github.com/hhandika/segul.git

Or clone and build it yourself. The binary is written to target/release/segul; copy it to a folder on your PATH.

Terminal window
git clone https://github.com/hhandika/segul
cd segul/
cargo build --release