Skip to main content

Installation guide

Sedge is currently available only for Linux, macOS, and Windows, for amd64 and arm64 architectures. You can use any of the following methods to install Sedge::

Download the binary from the release page​

Disclaimer

Downloading any binary from the internet risks downloading files that malicious, third-party actors have injected with malware. All users should check that they download the correct, clean binary from a reputable source.

  1. Download the correct binary for the machine you want to use for Sedge from the releases page, i.e. choose the correct target OS / Arch. For example: if your machine is an Intel / M1 mac then download the darwin-amd64 / darwin-arm64 binary. You can also download the binary from the CLI (command line interface) or Terminal with curl and wget:
curl -L https://github.com/NethermindEth/sedge/releases/download/v<VERSION>/sedge-v<VERSION>-<OS>-<ARCH> --output sedge

Replace <VERSION> with the desired version number, e.g 1.3.0; <OS> with your OS, e.g linux; and <ARCH> with your architecture, e.g amd64.

  1. Open a console or terminal instance on the directory you downloaded the binary.
  2. Set binary as executable executing chmod +x <binary> in the Terminal. Replace <binary> with the name of the downloaded binary.
  3. Run Sedge ./sedge --help to check if the executable is ok. The . represents the current directory (where your terminal session is pointing to)
  4. (Optional) Put the binary in your PATH with cp <binary> /usr/local/bin/sedge so you can execute Sedge from any directory using the Terminal. Try sedge --help now.

Using Homebrew​

First, install the Homebrew package manager using the official install script located on their homepage.

After installing Homebrew, you are ready to install Sedge by tapping into the official Sedge repository and installing it:

brew install nethermindeth/sedge/sedge

If you want to update Sedge, you can use the following commands:

brew update
brew upgrade sedge

If you want to remove Sedge, you can use:

brew uninstall sedge
brew untap nethermindeth/sedge

Using Go​

First, install the Go programming language following the official instructions. You need at least the 1.20 version.

tip

If you want to install Sedge on an M1 mac, then you need the darwin-arm64 package. You can find it byclicking on other downloads from the Go install page.

This command will install the sedge executable along with the library and its dependencies in your system:

go install github.com/NethermindEth/sedge/cmd/sedge@latest

The executable will be in your $GOBIN ($GOPATH/bin).

tip

To check if the GOBIN is not in your PATH, you can execute echo $GOBIN from the Terminal. If it doesn't print anything, then it is not in your PATH. To add GOBIN to your PATH, add the following lines to your $HOME/.profile:

export GOBIN=$GOPATH/bin
export PATH=$GOBIN:$PATH

Changes made to a profile file may not apply until the next time you log into your computer. To apply the changes immediately, run the shell commands directly or execute them from the profile using a command such as source $HOME/.profile.

Build from source​

tip

If you want to install Sedge on a Linux machine, we recommend installing some meta-packages to make the build process possible. You can install them with the following command in some of the major platforms:

Ubuntu and Debian based: sudo apt-get install gcc g++ abigen build-essential

Arch: sudo pacman -S base-devel

Alpine: sudo apk add alpine-sdk

With this method, you generate the binary manually (need Go installed), downloading and compiling the source code:

git clone https://github.com/NethermindEth/sedge.git
cd sedge
mkdir -p build
go build -o build/sedge cmd/sedge/main.go

or if you have make installed:

git clone https://github.com/NethermindEth/sedge.git
cd sedge
make compile

The executable will be in the build folder.

In case you want the binary in your PATH (or if you used the Using Go method and you don't have $GOBIN in your PATH), please copy the binary to /usr/local/bin:

# Using Go
sudo cp $GOPATH/bin/sedge /usr/local/bin/

# Build from source
sudo cp sedge/build/sedge /usr/local/bin/