Skip to content
otypePublic

About

An opinionated Emacs configuration

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

205 Commits

Folders and files

Repository files navigation

🧩 emacs.d

An opinionated Emacs configuration.

GitHub last commit GitHub issues GitHub pull requests LICENSE Emacs 30 or higher

Highlights · Preview · Getting started · Key bindings · Layout


✨ Highlights

📸 Preview

Emacs Dashboard Editing Emacs Lisp Magit status next to the code

🚀 Getting started

📋 Requirements

  • Emacs v30 or higher (the :vc keyword of use-package is used)
  • git and curl
  • Font Liberation Mono
  • A Nerd Font for the icons: install one with your package manager, or run M-x nerd-icons-install-fonts in Emacs
  • Ag - The Silver Searcher
  • Formatters for format-on-save (optional, per language):
    • black — Python (uv tool install black or pipx install black)
    • prettier — JavaScript and HTML (npm install -g prettier)
    • gofmt (ships with Go) and rustfmt (ships with rustup) are used for Go and Rust
  • Language servers for your active language layers:

⚡ Installation

One command clones the configuration to ~/.emacs.d, takes your name and email for user.el from git config, and installs all Emacs packages:

$ curl -fsSL https://raw.githubusercontent.com/otype/emacs.d/main/install.sh | bash

Prefer to read the script first?

$ curl -fsSLO https://raw.githubusercontent.com/otype/emacs.d/main/install.sh
$ less install.sh
$ bash install.sh

The installer is safe to run again: it fast-forwards an existing clone, leaves a checkout with local changes alone, and moves any other existing ~/.emacs.d to ~/.emacs.d.bak-<timestamp> before cloning. Options (append them to the pipe with bash -s -- <options>):

Option Effect
--check Report what would change and change nothing (exit 1 if anything would)
--no-packages Skip the headless package installation; packages then install on the first start of Emacs
--name NAME, --email EMAIL Set user-full-name and user-mail-address instead of using git config

It only warns about missing extras (Liberation Mono, a Nerd Font, ag, language servers, black, prettier) and never installs system packages.

After installing, enable more languages by uncommenting the (require 'lang-…) lines in init.el (check each file in /elisp/ for its dependencies), then start emacs.

🔧 Manual installation
$ git clone https://github.com/otype/emacs.d.git ~/.emacs.d
$ $EDITOR ~/.emacs.d/elisp/user.el   # your name and email
$ $EDITOR ~/.emacs.d/init.el         # enable language layers
$ emacs                              # installs all packages on first start

🔄 Updating

Run the installer again, or git pull --ff-only in ~/.emacs.d. Reload a running Emacs with C-c <f12>; restart it after package changes.

🔑 Key bindings

Everything this configuration binds is listed in docs/keybindings.md. The ones you will use most:

Binding What it does
C-c h … 🧭 Helm commands
C-c p … 📁 Projectile
C-c m … 🌿 Magit
C-c l … 🧠 LSP actions
C-c o …, C-c r … 📝 Org and 🕸️ Org-roam
C-c c 🤖 Claude Code menu
C-c d 📄 Duplicate line or region
C-c <f12> 🔄 Reload this configuration

📁 Project layout

Path Purpose
init.el Entry point: loads the layers below; language layers are switched on and off here
elisp/base*.el Core settings, theme, packages, custom functions, global key bindings
elisp/lang-*.el One self-contained layer per language
elisp/user.el Your name and email
themes/omarchy-theme.el Omarchy's Emacs theme file. Not in git (it is git-ignored): the Omarchy Emacs integration puts it next to this configuration and base-theme.el loads it
docs/ Documentation, e.g. the key bindings reference
images/ The screenshots shown in the preview
install.sh The installer
CLAUDE.md Notes for Claude Code: architecture, how to reload and validate changes
.githooks/ A pre-commit hygiene check. Enable it per clone with git config core.hooksPath .githooks

About

An opinionated Emacs configuration

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages