This page outlines alternative installation instructions for the
earthly build tool. The main instructions that most users need are available on the installation intructions page.
Download the binary relevant to your platform from the releases page, rename it to
earthly and place it in your
To initialize the installation, including adding auto-completion for your shell, run
sudo earthly bootstrap --with-autocomplete
and then restart your shell.
For instructions on how to install
earthly for CI use, see the CI integration guide.
Earthly can be installed for Debian and RedHat based Linux distributions via the Earthly deb and rpm repositories.
All of our binaries are signed with our PGP key; which has the fingerprint:
5816 B221 3DD1 CEB6 1FC9 52BA B118 5ECA 33F8 EB64
Debian-based repositories (including Ubuntu)
Debian-based Linux users (e.g. debian, ubuntu, mint, etc) can use our apt repo to install Earthly.
Before installing Earthly, you must first setup the Earthly apt repo.
Update apt and install required tools to support https-based apt repos:
sudo apt-get updatesudo apt-get install \apt-transport-https \ca-certificates \curl \gnupg \lsb-release
Download Earthly's GPG key:
curl -fsSL https://pkg.earthly.dev/earthly.pgp | sudo gpg --dearmor -o /usr/share/keyrings/earthly-archive-keyring.gpg
Setup the stable repo:
echo \"deb [arch=amd64 signed-by=/usr/share/keyrings/earthly-archive-keyring.gpg] https://pkg.earthly.dev/deb \stable main" | sudo tee /etc/apt/sources.list.d/earthly.list > /dev/null
sudo apt-get updatesudo apt-get install earthly
Fedora users can use our rpm repo to install Earthly.
Install plugins required to manage DNF repositories:
sudo dnf -y install dnf-plugins-core
Add the Earthly repo to your system:
sudo dnf config-manager \--add-repo \https://pkg.earthly.dev/earthly.repo
sudo dnf install earthly
CentOS users can use our rpm repo to install Earthly.
Install utils required to manage yum repositories:
sudo yum install -y yum-utils
Add the Earthly repo to your system:
sudo yum-config-manager \--add-repo \https://pkg.earthly.dev/earthly.repo
sudo yum install earthly
earthly.exe to your
PATH environment variable:
Search and select: System (Control Panel)
Click the Advanced system settings link.
Click Environment Variables. In the "System Variables" section, select the PATH environment variable and click Edit.
If the PATH environment variable does not exist, click New.
In the Edit window, specify the value of the PATH environment variable, and Click OK.
Close and reopen any existing terminal windows, so they will pick up the new
If you are going to mostly be working from a WSL2 prompt in Windows, you might want to consider following the Linux instructions for installation. This will help prevent any cross-subsystem file transfers and keep your builds fast. Note that the "original" WSL is unsupported.
To install from source, see the contributing page.
If you use SSH-based git authentication, then your git credentials will just work with Earthly. Read more about git auth.
For a full list of configuration options, see the Configuration reference
To verify that the installation works correctly, you can issue a simple build of an existing hello-world project
You should see the output
github.com/earthly/hello-world:main+hello | --> RUN [echo 'Hello, world!']github.com/earthly/hello-world:main+hello | Hello, world!github.com/earthly/hello-world:main+hello | Target github.com/earthly/hello-world:main+hello built successfully=========================== SUCCESS ===========================
To remove earthly, run the following commands:
brew uninstall earthlyrm -rf ~/.earthlydocker rm --force earthly-buildkitddocker volume rm --force earthly-cache
rm /usr/local/bin/earthlyrm /usr/share/bash-completion/completions/earthlyrm /usr/local/share/zsh/site-functions/_earthlyrm -rf ~/.earthlydocker rm --force earthly-buildkitddocker volume rm --force earthly-cache