Installation

Pre-requisites (all platforms)

Install earth

Linux

sudo /bin/sh -c 'wget https://github.com/earthly/earthly/releases/latest/download/earth-linux-amd64 -O /usr/local/bin/earth && chmod +x /usr/local/bin/earth && /usr/local/bin/earth bootstrap'

Alternatively, you may also download the linux binary from the releases page, rename it to earth and place it in your bin.

Mac

Homebrew

brew install earthly

Script

wget https://github.com/earthly/earthly/releases/latest/download/earth-darwin-amd64 -O /usr/local/bin/earth && chmod +x /usr/local/bin/earth && /usr/local/bin/earth bootstrap

Alternatively, you may also download the darwin binary from the releases page, rename it to earth and place it in your bin.

Windows via WSL (beta)

Earthly on Windows requires Docker Desktop WSL2 backend. Under wsl, run the following to install earth.

sudo /bin/sh -c 'wget https://github.com/earthly/earthly/releases/latest/download/earth-linux-amd64 -O /usr/local/bin/earth && chmod +x /usr/local/bin/earth && /usr/local/bin/earth bootstrap'

CI

For instructions on how to install earth 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

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

Syntax highlighting

VS Code extension

Earthfile Syntax Highlighting

Add Earthfile Syntax Highlighting to VS Code.

ext install earthly.earthfile-syntax-highlighting

Vim Plugin

Visit https://github.com/earthly/earthly.vim for details.

Sublime Text Package

Visit https://github.com/earthly/sublimetext-earthly-syntax for details.