The Sway toolchain is sufficient to compile Sway smart contracts. Otherwise, note that if you want to run Sway smart contracts (e.g. for testing), a Fuel Core full node is required, which is packaged together with the Sway toolchain together as the Fuel toolchain.
Installing via pre-compiled release binaries is the recommended way to get up and running with the Sway toolchain. Pre-compiled binaries for Linux and macOS are available. Native Windows is currently unsupported (tracking issue for Windows support). Windows Subsystem for Linux should work but is not officially supported.
fuelup is the equivalent of Rust's
rustup for the Fuel toolchain. It enables easily downloading binary releases of the Fuel toolchain.
Start by installing
fuelupwith the following command:
curl --proto '=https' --tlsv1.2 -sSf \ https://fuellabs.github.io/fuelup/fuelup-init.sh | sh
This downloads the
fuelup-initscript to a temp directory on your machine, which installs
fuelup-initwill ask for permission to add
~/.fuelup/binto your PATH. Otherwise, you can also pass
fuelup-initdoes not modify your PATH:
curl --proto '=https' --tlsv1.2 -sSf \ https://fuellabs.github.io/fuelup/fuelup-init.sh | sh -s -- --no-modify-path
Once fuelup is installed, fuelup-init automatically runs
fuelup toolchain install latestto install the latest toolchain
You can run
fuelup updateat anytime to get the most up-to-date toolchain.
(Optional) You can optionally install distributed toolchains optimized for different networks.
To configure the optimal toolchain for beta-2, run the following commands:
$ fuelup self update Fetching binary from https://github.com/FuelLabs/fuelup/releases/download/v0.18.0/fuelup-0.18.0-aarch64-apple-darwin.tar.gz Downloading component fuelup without verifying checksum Unpacking and moving fuelup to /var/folders/tp/0l8zdx9j4s9_n609ykwxl0qw0000gn/T/.tmpP3HfvR Moving /var/folders/tp/0l8zdx9j4s9_n609ykwxl0qw0000gn/T/.tmpP3HfvR/fuelup to /Users/user/.fuelup/bin/fuelup $ fuelup toolchain install beta-3 Downloading: forc forc-explore forc-wallet fuel-core fuel-indexer Adding component forc v0.35.0 to 'beta-3-aarch64-apple-darwin' Fetching binary from https://github.com/FuelLabs/sway/releases/download/v0.35.0/forc-binaries-darwin_arm64.tar.gz npacking and moving forc-doc to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Unpacking and moving forc to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Unpacking and moving forc-deploy to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Unpacking and moving forc-run to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Unpacking and moving forc-lsp to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Unpacking and moving forc-fmt to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Fetching core forc dependencies Installed forc v0.35.0 for toolchain 'beta-3-aarch64-apple-darwin' Adding component forc-explore v0.28.1 to 'beta-3-aarch64-apple-darwin' Fetching binary from https://github.com/FuelLabs/forc-explorer/releases/download/v0.28.1/forc-explore-0.28.1-aarch64-apple-darwin.tar.gz Unpacking and moving forc-explore to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Installed forc-explore v0.28.1 for toolchain 'beta-3-aarch64-apple-darwin' Adding component forc-wallet v0.1.3 to 'beta-3-aarch64-apple-darwin' Fetching binary from https://github.com/FuelLabs/forc-wallet/releases/download/v0.1.3/forc-wallet-0.1.3-aarch64-apple-darwin.tar.gz Unpacking and moving forc-wallet to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Installed forc-wallet v0.1.3 for toolchain 'beta-3-aarch64-apple-darwin' Adding component fuel-core v0.17.1 to 'beta-3-aarch64-apple-darwin' Fetching binary from https://github.com/FuelLabs/fuel-core/releases/download/v0.17.1/fuel-core-0.17.1-aarch64-apple-darwin.tar.gz Unpacking and moving fuel-core to /Users/user/.fuelup/toolchains/ beta-3-aarch64-apple-darwin/bin Installed fuel-core v0.17.1 for toolchain 'beta-3-aarch64-apple-darwin' Adding component fuel-indexer v0.2.3 to 'beta-3-aarch64-apple-darwin' Fetching binary from https://github.com/FuelLabs/fuel-indexer/releases/download/v0.2.3/fuel-indexer-0.2.3-aarch64-apple-darwin.tar.gz Unpacking and moving fuel-indexer to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin Installed fuel-indexer v0.2.3 for toolchain 'beta-3-aarch64-apple-darwin' Installed: - forc 0.35.0 - forc-explore 0.28.1 - forc-wallet 0.1.3 - fuel-core 0.17.1 - fuel-indexer 0.2.3 The Fuel toolchain is installed and up to date
You're all set to start building!
You may refer to The Fuelup Book for an in-depth look into fuelup, or check out the tooling section in the Fuel forum if you're running into problems through the installation process. If you don't see your question, post the issue you're running into with as many details as possible and the team will get back to you asap!
The Sway toolchain and Fuel Core full node can be installed from source with Cargo with:
cargo install forc fuel-core
You can update the toolchain from source with Cargo with:
cargo update forc fuel-core
The Fuel ecosystem has a few plugins which can be easily installed via Cargo.
forcdetects anything in your
forc-as a plugin. Use
forc pluginsto see what you currently have installed.
# Sway Formatter cargo install forc-fmt # Block Explorer cargo install forc-explore # Sway Language Server cargo install forc-lsp
A prerequisite for installing and using Sway is the Rust toolchain. Platform-specific instructions for installing
rustup can be found here. Then, install the Rust toolchain with:
# Install the latest stable Rust toolchain. rustup install stable
fuel-core may require installing additional system dependencies. See here for instructions.
The Sway toolchain is built and tested against the
stable Rust toolchain version (https://github.com/rust-lang/rust/releases/latest). There is no guarantee it will work with the
nightly Rust toolchain, or with earlier
stable versions, so ensure you are using
# Update installed Rust toolchain; can be used independently. rustup update # Set the stable Rust toolchain as default; can be used independently. rustup default stable
Rather than installing from
cargo, the Sway toolchain can be built from a local source checkout by following instructions at https://github.com/FuelLabs/sway. The Fuel Core full node implementation can be built from source by following instructions at https://github.com/FuelLabs/fuel-core.
forc supports generating completion scripts for Bash, Fish, Zsh, and PowerShell. See
forc completions --help for full details, but the gist is as simple as using one of the following:
# Bash forc completions --shell=bash > ~/.local/share/bash-completion/completions/forc # Bash (macOS/Homebrew) forc completions --shell=bash > $(brew --prefix)/etc/bash_completion.d/forc.bash-completion # Fish mkdir -p ~/.config/fish/completions forc completions --shell=fish > ~/.config/fish/completions/forc.fish # Zsh forc completions --shell=zsh > ~/.zfunc/_forc # PowerShell v5.0+ forc completions --shell=powershell >> $PROFILE.CurrentUserCurrentHost # or forc completions --shell=powershell | Out-String | Invoke-Expression
Once the completions have been generated and properly installed, close and reopen your terminal for the new completions to take effect.