The SEGUL CLI is a single executable named segul. Pick the method that fits your system:
| Method | Platforms | Best for |
|---|---|---|
| Installer script | Linux, macOS | The quickest install, no root access needed |
| Pre-compiled binary | Linux, macOS, Windows, WSL | Manual installs, Windows, offline machines |
| Conda | Linux, macOS | Conda users and shared environments |
| Cargo | Any platform Rust supports | Rust users; builds tuned for your hardware |
| Source code | Any platform Rust supports | The latest code, or beta features |
After installing, check that segul runs from any folder:
segul --versionInstaller script
Section titled “Installer script”On Linux and macOS, run:
curl -fsSL https://segul.app/install.sh | shThe 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.
| Option | Description |
|---|---|
--dir <path> | Install into another folder, such as --dir ~/bin. |
--version <tag> | Install a specific release, such as --version v0.23.2. |
--musl | Use the static Linux build even when GLIBC is new enough. |
--uninstall | Remove the installed binary. Add --dir if you used a custom folder. |
Pre-compiled binary
Section titled “Pre-compiled binary”Download the archive for your system from the latest release:
Linux
macOS
Windows
Linux x86_64 comes in two builds. Check your GLIBC version to choose:
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.
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.gztar xfvz segul-Linux-x86_64.tar.gzIf your shell does not recognize the binary, make it executable. Use
chmod a+xinstead to allow all users.Terminal window chmod +x segulMove
segulto a folder on yourPATH, such as~/bin. If the folder is not on yourPATHyet, add it to your shell profile. Runecho $SHELLto see your shell: use~/.bashrc(or~/.bash_profile) for bash and~/.zshrcfor zsh.Terminal window mkdir -p ~/bin && mv segul ~/bin/echo 'export PATH=$PATH:~/bin' >> ~/.bashrcsource ~/.bashrcCheck the installation with
segul --version.
Use segul-macOS-arm64.tar.gz for Apple silicon (M-series) Macs and segul-macOS-x86_64.tar.gz for Intel Macs.
Download and extract the archive.
Terminal window curl -LJO https://github.com/hhandika/segul/releases/latest/download/segul-macOS-arm64.tar.gztar xfvz segul-macOS-arm64.tar.gzIf your shell does not recognize the binary, make it executable.
Terminal window chmod +x segulMove
segulto a folder on yourPATH. macOS uses zsh by default, so add the folder to~/.zshrc.Terminal window mkdir -p ~/bin && mv segul ~/bin/echo 'export PATH=$PATH:~/bin' >> ~/.zshrcsource ~/.zshrcCheck the installation with
segul --version.
Use segul-Windows-x86_64.zip for most PCs and segul-Windows-arm64.zip for Windows on ARM, such as Copilot+ PCs. Native Windows is faster than running the Linux build in WSL.
- Download the zip file, right-click it, and select Extract All….
- Move
segul.exeto a folder you keep for command-line tools, such asC:\Tools. - Search for
envand open Edit the system environment variables. Select Environment Variables…, pickPathunder System variables, and select Edit…. Select New, add your folder, and close each dialog with OK. - Open a new terminal and 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:
conda install bioconda::segulmamba install segulDownload and run the Miniforge installer:
Terminal window curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"bash Miniforge3-$(uname)-$(uname -m).shOpen a new terminal and check that conda and mamba work. It prints both versions.
Terminal window mamba --versionAdd the Bioconda channel:
Terminal window conda config --add channels biocondaInstall SEGUL and check it:
Terminal window mamba install segulsegul --version
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:
cargo --versioncargo install segulIf compiling fails with a linker or build tool error, install the C build tools for your system and try again:
sudo apt install build-essentialsudo dnf groupinstall "Development Tools" "Development Libraries"sudo zypper install -t pattern devel_basisInstall the GNU toolchain with rustup, which comes with Rust, and make it the default:
rustup toolchain install stable-x86_64-pc-windows-gnurustup default stable-x86_64-pc-windows-gnuSource code
Section titled “Source code”Building from source also needs the Rust toolchain.
Install straight from the main branch on GitHub:
cargo install --git https://github.com/hhandika/segul.gitOr clone and build it yourself. The binary is written to target/release/segul; copy it to a folder on your PATH.
git clone https://github.com/hhandika/segulcd segul/cargo build --releaseNew features live in the dev branch until testing finishes, and the documentation marks them as beta. Use them for testing only; they may be unstable.
cargo install --git https://github.com/hhandika/segul.git --branch dev