Alternative installation
Last updated
Was this helpful?
Earthly 0.7
Last updated
Was this helpful?
This page outlines alternative installation instructions for the earthly build tool. The main instructions that most users need are available in , or on the .
or
(Windows only) or
Download the binary relevant to your platform from , rename it to earthly and place it in your bin.
To initialize the installation, including adding auto-completion for your shell, run
and then restart your shell.
For instructions on how to install earthly for CI use, see the .
You may optionally verify the checksum of the downloaded binaries, by performing the following steps:
Download our public key:
Verify the public key was correctly downloaded:
which should produce:
Import our key:
Trust our key:
Download the released checksum.asc file:
The latest version can be fetched from the command line with:
Verify the checksum.asc file was released correctly:
gpg is dangerous
Don't be tempted to remove the initial gpg --verify checksum.asc command; gpg will still output the checksum file even if the signature verification fails.
Verify the earthly binary checksum matches
This should display an entry similar to:
Important
Our rpm and deb repositories are currently in Beta stage.
Earthly can be installed for Debian and RedHat based Linux distributions via the Earthly deb and rpm repositories.
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 set up the Earthly apt repo.
Update apt and install required tools to support https-based apt repos:
Download Earthly's GPG key:
Setup the stable repo:
Install Earthly:
Fedora repositories
Fedora users can use our rpm repo to install Earthly.
Install plugins required to manage DNF repositories:
Add the Earthly repo to your system:
Install Earthly:
CentOS repositories
CentOS users can use our rpm repo to install Earthly.
Install utils required to manage yum repositories:
Add the Earthly repo to your system:
Install Earthly:
Important
Our native Windows release is currently in the Experimental stage.
The release ships with known issues. Many things work, but some don't.
To add 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 PATH.
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.
While installing earthly via Homebrew is the recommended approach, you can also download a binary directly. This may be useful when using earthly on a Mac in CI scenarios.
To verify that the installation works correctly, you can issue a simple build of an existing hello-world project
You should see the output
To remove earthly, run the following commands:
You can manually download it from the .
Check the for any known problems.
Give us feedback on .
All of our binaries are signed with our ; which has the fingerprint:
Check the for any known problems.
Give us feedback on .
To install the Windows release, simply the binary (or from our ); and ensure it is within your PATH.
When using a precompiled binary, you may need to add an exception to Gatekeeper. .
To install from source, see the .
If you use SSH-based git authentication, then your git credentials will just work with Earthly. Read more about .
For a full list of configuration options, see the