README.md

earthly-mode

Major mode for editing Earthly Earthfile (https://docs.earthly.dev/docs/earthfile) developed by @wingyplus, @TheCoreMan and @duck1123

Current features

• Syntax highlighting support.
• Toggle comment.

Requirements

For using:

• emacs

For testing changes:

• eldev - used for linting

Installation Notes

use-package

If you're using use-package, you can do:

(use-package earthfile-mode
  :ensure t)

Doom emacs

If you're using Doom emacs, you can add the following to ~/.doom.d/packages.el:

(package! earthfile-mode)

Followed by the following shell command:

~/.emacs.d/bin/doom sync

Manually via MELPA

Just run this command in Emacs:

M-x package-install RET earthfile-mode RET

Manual via local installation

Add earthfile-mode to load-path using add-to-list:

(add-to-list 'load-path "path/to/earthfile-mode")
(require 'earthfile-mode)

Screenshot