Get Earthly
- Linux
- placing the
earthlybinary in/usr/local/bin/and marking it as executable - installing auto-completion for your shell
- Mac
- Windows (WSL 2)
- placing the
earthlybinary in/usr/local/bin/and marking it as executable - installing auto-completion for your shell
Pre-requisites
Installation
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'
sudo is used for:
Pre-requisites
Installation
brew install earthly/earthly/earthly && earthly bootstrap
Pre-requisites
Installation
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'
sudo is used for:
📢 Get involved 📢
Thank you for giving Earthly a shot. Come and be part of the Earthly movement!
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:main+hello
This command executes the target hello from the repository github.com/earthly/hello-world on the branch main.
Syntax highlighting
- 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.
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:
Installing Earthly in CI
See the CI integration guide.
Next steps
To learn how to use Earthly, try
Need some inspiration to get started with your project? Check out examples on GitHub.