Skip to main content
Version: v. 1

Installation

If you face any issues while installing, check out the FAQ.

Precompiled binaries​

Precompiled binaries are available from the GitHub releases page. These are better managed by using Foxarup.

Using Foxarup​

Foxarup is the Foxar toolchain installer. You can find more about it here.

Open your terminal and run the following command:

curl -L https://up.foxar.dev | bash

This will install Foxarup, then simply follow the instructions on-screen, which will make the foxarup command available in your CLI.

Running foxarup by itself will install the latest (nightly) precompiled binaries: spark, probe, shuttle, and pilot. See foxarup --help for more options, like installing from a specific version or commit.

ℹ️ Note

If you're on Windows, you will need to install and use Git BASH or WSL, as your terminal, since Foxarup currently does not support Powershell or Cmd.

Building from source​

Prerequisites​

You will need the Rust compiler and Cargo, the Rust package manager. The easiest way to install both is with rustup.rs.

Foxar generally only supports building on the latest stable Rust version. If you have an older Rust version, you can update with rustup:

rustup update stable

On Windows, you will also need a recent version of Visual Studio, installed with the "Desktop Development With C++" Workloads option.

Building​

You can either use the different Foxarup flags:

foxarup --branch master
foxarup --path path/to/foxar

Or, by using a single Cargo command:

cargo install --git https://github.com/bchainhub/foxar --profile local --locked spark probe pilot shuttle

Or, by manually building from a local copy of the Foxar repository:

# clone the repository
git clone https://github.com/bchainhub/foxar.git
cd foxar
# install Spark
cargo install --path ./crates/spark --profile local --force --locked
# install Probe
cargo install --path ./crates/probe --profile local --force --locked
# install Shuttle
cargo install --path ./crates/shuttle --profile local --force --locked
# install Pilot
cargo install --path ./crates/pilot --profile local --force --locked

Installing for CI in Github Action​

See the bchainhub/foxar-toolchain GitHub Action.

Using Foxar with Docker​

Foxar can also be used entirely within a Docker container. If you don't have it, Docker can be installed directly from Docker's website.

Once installed, you can download the latest release by running:

docker pull ghcr.io/bchainhub/foxar:latest

It is also possible to build the docker image locally. From the Foxar repository, run:

docker build -t foxar .

For examples and guides on using this image, see the Docker tutorial section.

ℹ️ Note

Some machines (including those with M1 chips) may be unable to build the docker image locally. This is a known issue.