Install Murex

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.

Pre-Compiled Binaries (HTTPS download)

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

Installing From A Package Manager

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

ArchLinux

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 

FreeBSD Ports

pkg install murex

Homebrew

brew install murex

MacPorts

sudo port install murex

Compiling From Source

Prerequisites:

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

Go 1.20 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

Installation From Source Steps

Compiling from source is not recommended unless you already have a reasonable understanding of compiling Go projects for your specific platform.

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

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

However you can change the GOBIN value to point to any writable location you wish.

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

Recommended Terminal Typeface

This is obviously just a subjective matter and everyone will have their own personal preference. However if I was asked what my preference was then that would be Hasklig. It's a clean typeface based off Source Code Pro but with a few added ligatures - albeit subtle ones designed to make Haskell more readable. Those ligatures also suite Murex pretty well. So the overall experience is a clean and readable terminal.

See Also

• Compatibility Commitment: Hack confidence in our backwards compatibility
• Download: Murex download links
• Supported Platforms: Operating systems and CPU architectures supported by Murex

---

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