Alternative installation

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.

Pre-requisites

Install earthly

Download the binary relevant to your platform from the releases page, rename it to earthly and place it in your bin.

Note

To install earthly on the new Apple M1, we recommend using brew install earthly.

Alternatively, you may download the darwin-amd64 variant of the earthly binary and run it via Rosetta 2 (/usr/sbin/softwareupdate --install-rosetta --agree-to-license). Although the binary will be emulated, the builds themselves will run natively. The performance impact is not noticeable.

To initialize auto-completion, run

earthly bootstrap

and then restart your shell.

CI

For instructions on how to install earthly for CI use, see the CI integration guide.

Installing from source

To install from source, see the contributing page.

Configuration

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

Verify installation

To verify that the installation works correctly, you can issue a simple build of an existing hello-world project

earthly github.com/earthly/hello-world:main+hello

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 ===========================