git clone 'git://github.com/chrisdone/god-mode.git'
NOTE: Emacs 24.3 is required for this package to work well!
This is a global minor mode for entering Emacs commands without modifier keys. It's similar to Vim's separation of commands and insertion mode.
In the example below you can see how much effort is reduced:
Before: C-p C-k C-n M-^ ) C-j C-y M-r C-x z z M-2 M-g M-g C-x C-s After: p k n g ^ ) j y g r . . 2 g g x s
You'll find that this mode comes surprisingly naturally and that you already know how to run your existing Emacs commands.
See the Mapping section for a complete rundown of the transformations.
Load it up:
Activate for all future buffers by running
M-x god-mode. Although the
activation is buffer-local.
Toggle between God mode and non-God mode using
(global-set-key (kbd "<escape>") 'god-local-mode)
If you want to enable/disable on all active and future buffers, use this:
(global-set-key (kbd "<escape>") 'god-mode-all)
If you are using the global mode, you might want to make no buffers exempt:
(setq god-exempt-major-modes nil) (setq god-exempt-predicates nil)
This means that e.g. magit-mode or dired-mode will also enter god-mode when you activate it globally, and vise-verse. It means you can always reliably use god-mode commands in any buffer as long as it is globally activated.
Also, you can add this to your
.xmodmap to rebind Caps Lock to
remove Lock = Caps_Lock keysym Caps_Lock = Escape
xmodmap .xmodmap for the changes to take effect immediately.
Or use dconf:
dconf write /org/gnome/desktop/input-sources/xkb-options "['caps:escape']"
See here for more details.
This library defines the following mapping:
All commands are assumed to be
C-<something> unless otherwise
C-a C-k C-n C-y
x s →
Note the use of space to produce
g is a special key to indicate
M-<something>. This means that
there is no way to write
C-g in this mode, you must therefore
C-g directly. Examples:
G is a special key to indicate
M-f M-f M-f
Universal boolean argument:
C-u C-c C-o
You can change the cursor style indicate whether you're in God mode or not.
(defun my-update-cursor () (setq cursor-type (if (or god-local-mode buffer-read-only) 'box 'bar))) (add-hook 'god-mode-enabled-hook 'my-update-cursor) (add-hook 'god-mode-disabled-hook 'my-update-cursor)
You can use the following function to switch the entire modeline's foreground and background:
(defun c/god-mode-update-cursor () (let ((limited-colors-p (> 257 (length (defined-colors))))) (cond (god-local-mode (progn (set-face-background 'mode-line (if limited-colors-p "white" "#e9e2cb")) (set-face-background 'mode-line-inactive (if limited-colors-p "white" "#e9e2cb")))) (t (progn (set-face-background 'mode-line (if limited-colors-p "black" "#0a2832")) (set-face-background 'mode-line-inactive (if limited-colors-p "black" "#0a2832")))))))
You can pause
overwrite-mode is enabled and resume
overwrite-mode is disabled.
(defun god-toggle-on-overwrite () "Toggle god-mode on overwrite-mode." (if (bound-and-true-p overwrite-mode) (god-local-mode-pause) (god-local-mode-resume))) (add-hook 'overwrite-mode-hook 'god-toggle-on-overwrite)
There is a small module for providing god-mode-like behaviour for
isearch: You can hit
s hello <escape> s s s RET
C-s hello C-s C-s C-s RET
Activate and configure with the following:
(require 'god-mode-isearch) (define-key isearch-mode-map (kbd "<escape>") 'god-mode-isearch-activate) (define-key god-mode-isearch-map (kbd "<escape>") 'god-mode-isearch-disable)
god-mode-isearch-map for additional keybindings.
If you want to use god-mode with fast-keys, you can use a rebinding of self-insert like this:
(define-key god-local-mode-map [remap self-insert-command] 'my-god-mode-self-insert) (defun my-god-mode-self-insert () (interactive) (if (and (bolp) (eq major-mode 'org-mode)) (call-interactively 'org-self-insert-command) (call-interactively 'god-mode-self-insert)))
The following customizations are popular:
(define-key god-local-mode-map (kbd "z") 'repeat) (define-key god-local-mode-map (kbd "i") 'god-local-mode)
Although I personally prefer:
(define-key god-local-mode-map (kbd ".") 'repeat)
Feel free to alter and customize as you prefer.
Also handy are these:
(global-set-key (kbd "C-x C-1") 'delete-other-windows) (global-set-key (kbd "C-x C-2") 'split-window-below) (global-set-key (kbd "C-x C-3") 'split-window-right) (global-set-key (kbd "C-x C-0") 'delete-window)
So that you can run
x0 in god-mode.
Note: This is less necessary in recent god-mode, as god-mode overrides all printable single byte keys, so it will override dired-mode or magit-mode.
If you do
M-x god-mode, then all buffers will be started in God
mode. If you don't like that behavior, just use the
toggler with a keybinding.
god-mode is enabled in buffers where it makes no sense. In
that case you can add the major mode to
(add-to-list 'god-exempt-major-modes 'dired-mode)
dired-mode is already in the list, that's a noop, but you get
the idea. Consider opening an issue or pull request if you find a
major mode that should be on the official list.
Another option to control god-mode's global behavior is to provide a
function with no arguments that must return non-nil if god-mode should
be disabled for the current buffer. See the
variable and its default members