This guide will help you to install the Fuel toolchain binaries and prerequisites.
This guide covers the following topics:
The Fuel toolchain is built on top of the Rust programming language. To install Rust, you can use the
Run the following command in your shell; this downloads and runs
rustup-init.sh, which in turn downloads and runs the correct version of the
rustup-init executable for your platform.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Check the official Rust documentation to get more information on installing the Rust toolchain .
fuelup is the official package manager for Fuel that installs the Fuel toolchain
from the official release channels, enabling you to easily switch between different
toolchains and keep them updated. It makes building and maintaining Sway applications simpler with
fuel-core for common platforms.
💡 Check out the fuelup docs for more information.
To install the Fuel toolchain, you'll use the
This will install
forc-wallet as well as
👉 Just paste the following line in your terminal and press Enter.
curl --proto '=https' --tlsv1.2 -sSf https://install.fuel.network/fuelup-init.sh | sh
🚧 Be aware that currently we do not natively support Windows. If you wish to use
fuelupon Windows, please use Windows Subsystem for Linux.
Once the script is downloaded, it will be executed automatically.
fuelup-init script will prompt you with the question below:
fuelup uses "/home/username/.fuelup" as its home directory to manage the Fuel toolchain, and will install binaries there. To use the toolchain, you will have to configure your PATH, which tells your machine where to locate `fuelup` and the Fuel toolchain. If permitted, fuelup-init will configure your PATH for you by running the following: echo "export PATH="$HOME/.fuelup/bin:$PATH"" >> /home/username/.bashrc Would you like fuelup-init to modify your PATH variable for you? (N/y)
👉 Press the
Y key in your terminal and press Enter to modify your PATH.
After allowing the
fuelup-init script to modify your
PATH variable, you will see a lot of information about packages being downloaded and installed. If everything goes as expected you will see the following message:
The Fuel toolchain is installed and up to date fuelup 0.19.5 has been installed in /home/username/.fuelup/bin. To fetch the latest toolchain containing the forc and fuel-core binaries, run 'fuelup toolchain install latest'. To generate completions for your shell, run 'fuelup completions --shell=SHELL'.
fuelup --version any time to check which version of the package you are using.
That will output your current
Just as in Rust , Fuel supports multiple toolchains. A toolchain is a collection of tools (such as the compiler, LSP, etc).
fuelup includes a series of packages tested to work with each other, providing a reliable set of tools.
In this case, we will install the
beta-4 toolchain, which is the stable toolchain compatible with the
For more information on
beta-4 check the Fuel blog page.
Make sure you have the latest version of
fuelup so you can access the latest features and have the best performance.
fuelup by running the following command:
fuelup self update
Then you will get an output like this:
Fetching binary from https://github.com/FuelLabs/fuelup/releases/download/v0.19.5/fuelup-0.19.5-aarch64-apple-darwin.tar.gz Downloading component fuelup without verifying checksum Unpacking and moving fuelup to /var/folders/tp/0l8zdx9j4s9_n609ykwxl0qw0000gn/T/.tmpiNJQHt Moving /var/folders/tp/0l8zdx9j4s9_n609ykwxl0qw0000gn/T/.tmpiNJQHt/fuelup to /Users/.fuelup/bin/fuelup
To properly interact with the
beta-4 network it is necessary to use its corresponding toolchain.
👉 Run the following command to install the
fuelup toolchain install beta-4
If the toolchain was successfully installed, you will see this output:
The Fuel toolchain is installed and up to date
The toolchain was installed correctly, however is not in use yet. Next, you need to configure
fuelup to use the
beta-4 toolchain as the default.
beta-4 as your default toolchain with the following command:
fuelup default beta-4
You will get the following output indicating that you have successfully set
beta-4 as your default toolchain.
default toolchain set to 'beta-4'
Sometimes you might end up using multiple toolchains at once. Don't worry if you get confused about which toolchain you are using, since you can check your current toolchain anytime.
👉 Run the
fuelup show command to see the toolchain and the versions of each tool you are using.
This command will give you the following output
active toolchain ----------------- beta-4-x86_64-unknown-linux-gnu (default) forc : 0.45.0 - forc-client - forc-deploy : 0.45.0 - forc-run : 0.45.0 - forc-doc : 0.45.0 - forc-explore : 0.28.1 - forc-fmt : 0.45.0 - forc-index : 0.20.7 - forc-lsp : 0.45.0 - forc-tx : 0.45.0 - forc-wallet : 0.3.0 fuel-core : 0.20.4 fuel-core-keygen : Error getting version string fuel-indexer : 0.20.7 fuels versions --------------- forc : 0.45 forc-wallet : 0.45
As you can see, the
beta-4 toolchain is active 🚀
Now you are ready to start building with Fuel.
👉 Check out the quickstart guide to deploy your first smart contract.
You can create your own set of specific versions, this is known as 'custom toolchains'.
👉 Visit the Fuelup docs to learn how to set up your own custom toolchains.
You can always build the Fuel packages from source.
👉 Visit the Fuelup docs to get more details about other types of installation.
It's always possible to run a development environment in the browser.
👉 Please visit our guide on Github Codespaces to use the Fuel toolchain in the browser.