Doom Emacs is an Emacs Lisp development tool and configuration framework for GNU Emacs, tailored for Emacs enthusiasts that want a faster, more reliable, and reproducible foundation for their next config or elisp project, or for beginners who want a softer introduction to our favorite operating system.

Quick start


        git clone --depth 1 https://github.com/doomemacs/core ~/.config/emacs

        ~/.config/emacs/bin/doom install

This is the quickest way to get a Doom environment up and running. Visit our getting started guide for more in-depth instructions (it's quite outdated at the moment, but I'm working on it).

Updating Doom


        ~/.config/emacs/bin/doom upgrade

If this fails, see doom upgrade --help for steps to manually update Doom.

Prerequisites

GNU Emacs 27.1–31.1 (31.1 is recommended)
- Using only Doom's CLI requires 27.1+
- Using Doom as a starter kit requires 29.1+
Git >= 2.23
Ripgrep >= 11.0
Emacs dependencies:
- GNU variants of find, ls, diff, and tar
- Symbola font (Emacs' fallback font for glyphs it can't display)
Optional, but recommended dependencies:
- fd 7.3.0+ (used to improve file indexing performance)
- Symbols Nerd Font (optional — GUI only): Doom uses this font to display icons. Linux users can install it via their OS package manager or from within Doom Emacs via M-x nerd-icons-install-font. Windows and MacOS users will need to manually install the font from nerdfonts.com. Alternatively, you can use one of the many patched Nerd Fonts as your primary font in Emacs.

Warning

Avoid unstable and pre-release builds of Emacs. These end in .50, .60, or .9X (e.g. 28.1.91). Doom should generally work on Emacs HEAD (the maintainer dogfoods it), but support lags behind the bleeding edge by at least a month or so.

Important

Many of Doom's modules have their own dependencies. Visit their README.org for instructions on how to acquire them (accessible within Doom Emacs via M-x doom/docs-modules too). Running $ doom doctor in the shell will summarize what dependencies you're missing (and diagnose any common issues with your environment).

Project resources

Github Repositories:
Discord Server
Github Discussions
WIP Official documentation (see our in-repo docs for now)
WIP Community wiki (see our Discourse archives for now)
Announcements
WIP Project roadmap
Do-Not-PR list
Packages under review

Frequently asked questions

youtube.com/@doomemacs
fosstodon.org/@doomemacs
twitter.com/doomemacs (mirrored from fosstodon)
bsky.app/profile/doomemacs.org (mirrored from fosstodon)

Support the project

Doom and its community are labors of love and the incurable madness of its maintainer and volunteers. Doom wouldn't be where it is today without your help. Help us keep us going by contributing bug reports, code, and documentation, or sponsoring the author.