Installing Huff

The Huff Compiler (opens new window) is built in Rust to create an extremely performant experience compiling huff.

Installation of the compiler is similar to that of Foundry (opens new window).

First, install huffup, a version control manager for the Huff Compiler:

curl -L get.huff.sh | bash

NOTE: This installs the huffup binary, but does not guarantee it is added to your path. If you get an error like huffup: command not found, you will need to source your path by running source ~/.bashrc or source ~/.zshrc. Alternatively, you can open a new terminal window.

Now, with huffup installed and in your path, you can simply run huffup to install the latest stable version of huffc (the huff compiler).

On Windows, build from the source

If you use Windows, you need to build from the source to get huff.

Download and run rustup-init from rustup.rs (opens new window). It will start the installation in a console.

If you encounter an error, it is most likely the case that you do not have the VS Code Installer which you can download here (opens new window) and install.

After this, run the following to build huff from the source:

cargo install --git https://github.com/huff-language/huff-rs.git huff_cli --bins --locked

To update from the source, run the same command again.

🎉 TADA, Huff is installed! 🎉

To verify for yourself that it's installed, run huffc --help to view the help menu.

If you get an error, or it is not installing correctly, send a message in the #help channel of the Huff Language Discord Server (opens new window).

To get started compiling Huff Contracts, check out compiling (opens new window).

To diver deeper into the compiler's cli abilities, check out the cli docs (opens new window).