An excerpt from the repository, fetched Nov 13, 2026.
Read the project’s introduction
philosophy
|
for whom?
|
screenshots
|
documentation
|
contribute
|
achievements
|
FAQ
Quick Start
If you don't have an existing Emacs setup and want to run Spacemacs as your
configuration, and if you have all prerequisites installed,
you can install Spacemacs with one line:
shell:
git clone https://github.com/syl20bnr/spacemacs "${HOME}/.emacs.d"
Windows PowerShell:
git clone https://github.com/syl20bnr/spacemacs "${HOME}/.emacs.d"
If HOME is not set in environment or in registry:
git clone https://github.com/syl20bnr/spacemacs "${env:APPDATA}/.emacs.d"
If you do have an existing Emacs configuration, look at the full installation
instructions for other options.
Introduction
Spacemacs is a new way of experiencing Emacs -- it's a sophisticated and
polished set-up, focused on ergonomics, mnemonics and consistency.
Just clone and launch it, then press the space bar to explore the interactive
list of carefully-chosen key bindings. You can also press the home buffer's
[?] button for some great first key bindings to try.
Spacemacs can be used naturally by both Emacs and Vim users -- you can even mix
the two editing styles. Being able to quickly switch between input styles, makes
Spacemacs a great tool for pair-programming.
Spacemacs is currently in beta, and any contributions are very welcome.
Features
Great documentation: access the Spacemacs documentation with
SPC h SPC.
Beautiful GUI: you'll love the distraction free UI and its functional
mode-line.
Excellent ergonomics: all the key bindings are accessible by pressing the
SPC or Alt-m.
Mnemonic key bindings: commands have mnemonic prefixes like
SPC b for all the buffer commands or SPC p for the project
commands.
Batteries included: discover hundreds of ready-to-use packages nicely
organized in configuration layers following a set of conventions
.
Documentation
Comprehensive documentation is available for each layer by pressing SPC h
SPC.
You can also check the general documentation,
quick start guide and the FAQ.
Getting Help
If you need help, ask your questions in the Gitter Chat and a member of the
community will help you out.
If you prefer IRC, connect to the Gitter Chat IRC server and join the
#syl20bnr/spacemacs channel.
Last but not least there are a lot of high class tutorials available on YouTube:
Jack of Some's Spacemacs tutorial videos.
GDQuest's Game Design oriented tutorials to Spacemacs.
Practicalli's Clojure tutorials based on Spacemacs.
Eivind Fonn's classic Spacemacs ABC.
Prerequisites
A package manager if the OS doesn't have one already.
Spacemacs is an extension of a popular text editor called Emacs.
So you'll need Emacs installed first.
Spacemacs requires Emacs 28.2 or above. The development version of Emacs is
not officially supported, but it should nevertheless be expected to work.
git is required to download and update Spacemacs.
Tar, in particular GNU Tar, is required to install and update Emacs
packages used by Spacemacs.
(Optional) The default font used by Spacemacs is Source Code Pro. You
may customize your own font settings and choose another font. If you want to
use this default font, it must be installed.
Spacemacs also uses fallback fonts to ensure certain Unicode symbols it uses
symbols appear correctly. The fonts used are determined by the OS:
Linux: Nanum Gothic
macOS: Arial Unicode MS
Windows: MS Gothic and Lucida Sans Unicode
If the mode-line doesn't look similar to the picture at the top of this
page, make sure you have the correct fallback font installed.
(Optional) Various commands in Spacemacs needs one of the following line
searching program:
ripgrep (rg)
The silver searcher (ag)
ack
GNU Grep or BSD Grep
Grep is very slow but it's widely available on most systems and is used as an
fallback option.
We strongly recommend ripgrep over other line searching programs, for its
blazing fast speed. The following subsections helps you to install it.
Linux
Most Linux distribution ships a package manager already and if this is the
case you are all set for this step.
If it doesn't, you may need to build the software mentioned below from their
sources.
In most distributions, Emacs is installed via an emacs package from the
package manager.
N.B. DO not install XEmacs because it's not supported by Spacemacs.
XEmacs is an old fork of Emacs with various subtle
differences.
N.B. Some Linux distributions support only Emacs versions older than
28.2. In this case you should
build it from source instead.
Very likely Git is already installed on your system. Otherwise, you should
be able to install git from your system's package manager.
Very likely Tar is already installed on your system. Otherwise, you should
be able to install tar from your system's package manager.
(Optional) If Nerd Fonts and Nanum Gothic are available from your
distribution's package manager, you should install it there.
Otherwise, the generic way to install it is:
Download the latest pre-built TTF font from
https://github.com/adobe-fonts/source-code-pro/releases/latest and
https://fonts.google.com/specimen/Nanum+Gothic.
Extract the archive and move the font files to ~/.fonts.
Refresh font cache with:
fc-cache -fv
(Optional) If your distribution is listed
here, follow the instructions to install
ripgrep (rg). Otherwise, you can download its pre-built binary or
build it from source.
macOS
The most popular package manager on macOS is Homebrew, to install it:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Several options exist for installing Emacs on macOS:
Emacs Plus features additional functionalities
over base Emacs.
brew tap d12frosted/emacs-plus
# install latest stable release, with Spacemacs icon and native compilation
brew install emacs-plus --with-spacemacs-icon --with-native-comp
You will require the latest version of Xcode Command Line tools, which can be
downloaded from the Apple Developer Portal
or by running the following comm
Read the full README on GitHub