Skip to content

Installation

QSMxT ships as a single self-contained binary. There is no environment to manage and no toolbox to assemble.

Terminal window
curl -fsSL https://raw.githubusercontent.com/QSMxT/QSMxT/main/install.sh | sh
Terminal window
irm https://raw.githubusercontent.com/QSMxT/QSMxT/main/install.ps1 | iex

The installer places the qsmxt binary on your PATH and installs a pinned copy of dcm2niix (used for DICOM → BIDS conversion) into ~/.qsmxt/bin.

Terminal window
qsmxt --version
qsmxt --help
Terminal window
qsmxt update

This checks the latest release, installs it if newer, and keeps the bundled dcm2niix in sync.

qsmxt tui also checks for new releases in the background and offers the update in a pop-up when one is available. The check runs on its own thread and its result is cached for 24 hours, so it never delays startup. From the pop-up, Enter installs the update, Esc defers it to the next launch, and d skips that release for good.

Set QSMXT_NO_UPDATE_CHECK=1 to turn the background check off entirely. It is also skipped automatically when CI is set and in local development builds.

Grab the archive for your platform from the Releases page and extract qsmxt somewhere on your PATH. Builds are provided for:

  • x86_64 / aarch64 Linux (gnu + musl)
  • x86_64 / aarch64 macOS
  • x86_64 / aarch64 Windows

Requires a recent Rust toolchain (edition 2021+).

Terminal window
git clone https://github.com/QSMxT/QSMxT
cd QSMxT
cargo build --release
# binary at target/release/qsmxt
Terminal window
# Linux / macOS
curl -fsSL https://raw.githubusercontent.com/QSMxT/QSMxT/main/uninstall.sh | sh
Terminal window
# Windows PowerShell
irm https://raw.githubusercontent.com/QSMxT/QSMxT/main/uninstall.ps1 | iex