Installation¶

Lodestar runs on Linux, MacOS and Windows.

Install from source¶

Make sure to have Yarn installed. It is also recommended to install NVM (Node Version Manager) and use the latest LTS version of NodeJS.

Clone the repo locally.

git clone https://github.com/chainsafe/lodestar.git

Install across all packages. Lodestar follows a monorepo structure, so all commands below must be run in the project root. Use the --ignore-optional flag to prevent downloading the Ethereum Consensus spec tests.

yarn install --ignore-optional

Build across all packages

yarn run build

Or if you are using Lerna:

lerna bootstrap

Lodestar should now be ready for use:

./lodestar --help

Install from NPM¶

Install globally

npm install -g @chainsafe/lodestar-cli

or

yarn global add @chainsafe/lodestar-cli

Lodestar should now be ready to use:

lodestar --help

Install with docker¶

The chainsafe/lodestar Docker Hub repository is mantained actively. It contains the lodestar CLI preinstalled.

Ensure you have Docker installed by issuing the command:

docker -v

It should return a non error message such as Docker version xxxx, build xxxx.

Pull, run the image and Lodestar should now be ready to use

docker pull chainsafe/lodestar
docker run chainsafe/lodestar --help

Specifications¶

Hardware specifications minimum / recommended, to run the Lodestar client.