Installing

Binaries

To install Forest from pre-compiled binaries, please refer to the releases page, or consider using Docker.

Docker

Images

Images are available via Github Container Registry:

ghcr.io/chainsafe/forest

You will find tagged images following these conventions:

• latest - latest stable release
• vx.x.x - tagged versions
• edge - latest development build of the main branch
• date-digest (e.g., 2023-02-17-5f27a62) - all builds that landed on the main branch

A list of available images can be found here: https://github.com/ChainSafe/forest/pkgs/container/forest

Basic Usage

Running the Forest daemon:

❯ docker run --init -it --rm ghcr.io/chainsafe/forest:latest --help

Using forest-cli:

❯ docker run --init -it --rm --entrypoint forest-cli ghcr.io/chainsafe/forest:latest --help

Build From Source

Dependencies

• Rust compiler (install via rustup)
• OS Base-Devel/Build-Essential
• Clang compiler

For Ubuntu, you can install the dependencies (excluding Rust) with:

sudo apt install build-essential clang

Compilation & installation

From crates.io (latest release)

cargo install forest-filecoin

From repository (latest development branch)

# Clone the Forest repository
git clone --depth 1 https://github.com/ChainSafe/forest.git && cd forest
make install

Both approaches will compile and install forest and forest-cli to ~/.cargo/bin. Make sure you have it in your PATH.

Verifying the installation

Ensure that Forest was correctly installed.

❯ forest --version
forest-filecoin 0.19.0+git.671c30c