Get started with Earthly
Earthly is Better Logged In
A better, interactive version of this installation guide is available in Earthly Cloud. Earthly Cloud gives you consistent builds, ridiculous speed, a next-gen developer experience, and it works with any CI. It's your Earthly builds in the cloud. Get 6,000 minutes/month for free by visiting the sign up page.
Install Earthly CLI
Select your OS:
- Linux
- placing the
earthlybinary in/usr/local/bin/and marking it as executable - installing auto-completion for your shell
- Rootless Podman is not officially supported. Run podman with
sudo - Mac
- Homebrew may require additional configuration in your profile
- Ensure Podman Machine is running before running bootstrap
- Rootless Podman is not officially supported. Learn how to switch to rootful mode
- Windows
- placing the
earthlybinary in/usr/local/bin/and marking it as executable - installing auto-completion for your shell
- Rootless Podman is not officially supported. Run podman with
sudo
sudo /bin/sh -c 'wget https://github.com/earthly/earthly/releases/latest/download/earthly-linux-amd64 -O /usr/local/bin/earthly && chmod +x /usr/local/bin/earthly && /usr/local/bin/earthly bootstrap --with-autocomplete'
Copy
sudo is used for:
For Podman:
brew install earthly && earthly bootstrap
Copy
Pre-requisites
For shell auto-completion:
For Podman:
Under wsl, run the following to install earthly.
sudo /bin/sh -c 'wget https://github.com/earthly/earthly/releases/latest/download/earthly-linux-amd64 -O /usr/local/bin/earthly && chmod +x /usr/local/bin/earthly && /usr/local/bin/earthly bootstrap --with-autocomplete'
Copy
Pre-requisites
sudo is used for:
For Podman:
For alternative installation options see the alternative installation page in the Earthly docs. To install Earthly from source, see the contributing page in GitHub
Verify Installation
earthly github.com/earthly/hello-world+hello
Copy
This command executes the target hello from the repository github.com/earthly/hello-world.
Add Syntax Highlighting
Select your IDE:
- VS Code
- Vim
- Emacs
- Sublime Text
- Press
Ctrl+Shift+P(orCmd+Shift+Pon Mac) to bring up the Command Palette, and select Install Package control (if you haven’t already installed Package Control). - Press
Ctrl+Shift+P(orCmd+Shift+Pon Mac) again, select “Package Control: Install Package” and select Earthly Earthfile to install. - IntelliJ
Add Earthfile Syntax Highlighting to VS Code.
ext install earthly.earthfile-syntax-highlighting
Visit earthly.vim on GitHub for details.
If you are using use-package:
(use-package earthfile-mode
:ensure t)
Alternatively, install via package-install:
M-x package-install RET earthfile-mode RET
Add the Earthly Earthfile package via Package Control:
Earthly plugin available in the IntelliJ Marketplace.
Next Steps
Learn more about Earthly through docs and examples and how to use Earthly with your existing CI
Learn Earthly
To learn how to use Earthly, try:
Example projects
Need some inspiration to get started with your project?
Check out examples on GitHub
Run Earthly in CI
See the CI integration guide to use Earthly in GitHub Actions, Circle CI, Jenkins, GitLab CI, and others.
You can also use Earthly Satellites (part of Earthly Cloud) in your CI system. Satellites are remote build runners that make builds fast, are super simple to use, and work seamlessly with any CI. See the Earthly Satellites docs for more information.