Install

Supported Platforms

Linux, BSD and macOS are fully supported, with other platforms considered experimental and/or having known limitations.

Windows is a supported platform however Murex doesn't aim to replace coreutils. So, depending on your required use case, you may need additional 3rd party software to provide those utilities.

There is a more detailed breakdown of known compatibility issues in the supported platforms document.

Installing From A Package Manager

This is the recommended way to install Murex because you can then stay updated with future releases.

# via Homebrew:
brew install murex

# via MacPorts:
port install murex

# From AUR: https://aur.archlinux.org/packages/murex
wget -O PKGBUILD 'https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=murex'
makepkg --syncdeps --install 

pkg install murex

Pre-Compiled Binaries (HTTPS download)

If you wish to download a pre-compiled binary then head to the DOWNLOAD page to select your platform.

Compiling From Source

Murex is designed to be as easy to compile as possible. However if you do not have any prior experience with compiling software from source then the recommended approach for installing Murex is either via a package manager (if your platform is already supported) or downloading one of our pre-compiled binaries.

Prerequisites

You will need go (Golang) compiler, and git installed.

Go 1.21 or higher is required.

These should be easy to install on most operating systems however Windows is a lot more tricky with regards to gcc. Please check with your operating systems package manager first but see further reading below if you get stuck.

Further Reading:

• How to install Go
• How to install git

Compiling

Installation from source is as simple as the following one liner:

GOBIN="$(pwd)" go install -v github.com/lmorg/murex@latest

$env:GOBIN="$(pwd)"; & go install -v github.com/lmorg/murex@latest

Makefile: Linux, MacOS, UNIX

We also provide a Makefile.

This is convenient if you already have the source downloaded or want to taylor the install. For example reintroduce a deprecated builtin, add optional builtins, or utilize a different backend library for networking and/or sqlite3.

For options available in the Makefile, run make help.

External Dependencies (Optional)

Some of Murex's extended features will have additional external dependencies.

• aspell: This is used for spellchecking. Murex will automatically enable or disable spellchecking based on whether aspell can be found in your $PATH. http://aspell.net

• git: This is used by Murex's package manager, murex-package. How to install git

See Also

• Compatibility Commitment: Murex is committed to excellent backwards compatibility
• Download Links: Murex download links
• Supported Platforms: Operating systems and CPU architectures supported by Murex

---

This document was generated from gen/root/INSTALL_doc.yaml.