installation.md

Installation

There are three main ways to install medusa at the moment. The first is using Homebrew, building from source, or installing a precompiled binary.

If you have any difficulty with installing medusa, please open an issue on GitHub.

Installing with Homebrew

Note that using Homebrew is only viable (and recommended) for macOS and Linux users. For Windows users, you must build from source or install a precompiled binary.

Prerequisites

Installation instructions for Homebrew can be found here.

Install medusa

Run the following command to install medusa:

brew install medusa

Building from source

Prerequisites

Before downloading medusa, you will need to download Golang and crytic-compile.

• Installation instructions for Golang can be found here
• Installation instructions for crytic-compile can be found here
  • Note that crytic-compile requires a Python environment. Installation instructions for Python can be found here.

Build medusa

Run the following commands to build medusa (this should work on all OSes):

# Clone the repository
git clone https://github.com/crytic/medusa

# Build medusa
cd medusa
go build -trimpath

You will now need to move the binary (medusa or medusa.exe) to somewhere in your PATH environment variable so that it is accessible via the command line. Please review the instructions here (if you are a Windows user, we recommend using the Windows GUI).

Precompiled binaries

The precompiled binaries can be downloaded on medusa's GitHub releases page.

NOTE: macOS may set the quarantine extended attribute on the downloaded zip file. To remove this attribute, run the following command: sudo xattr -rd com.apple.quarantine <my_file.tar.gz>.

Once installed, you will need to unzip the file and move the binary to somewhere in your $PATH. Please review the instructions here (if you are a Windows user, we recommend using the Windows GUI).