crux

A Collection of Ridiculously Useful eXtensions for Emacs. crux bundles many useful interactive commands to enhance your overall Emacs experience.

Most of the crux commands are related to the editing experience, but there are also a bunch of utility commands that are just very useful to have (e.g.

crux-open-with

crux-reopen-as-root

Origins of crux

Many of the functions in crux started life as blog posts on Emacs Redux, then were included in Emacs Prelude, before finally being extracted to crux. You can see a full list of blog posts on functions in crux on the tags page.

Installation

Available on all major

package.el

MELPA Stable is recommended as it has the latest stable version. MELPA has a development snapshot for users who don't mind breakage but don't want to run from a git checkout.

You can install

crux

M-x package-install [RET] crux [RET]

If the installation doesn't work try refreshing the package list:

M-x package-refresh-contents

Alternatively, you can add the following code to your Emacs config:

(unless (package-installed-p 'crux)
  (package-refresh-contents)
  (package-install 'crux))

Keybindings

crux doesn't setup any keybindings for its commands out-of-the-box. There are several reasons for this:

• Most users probably won't need all the commands, so it'd be an overkill to define a minor mode consuming a lot of valuable keybindings
• Many of the optimal keybindings are in the user space anyways (e.g.

  C-c some-letter

  )
• Everyone has their own preferences when it comes to keybindings

Here's the list of some suggested keybindings. Feel free to bind individual commands to whatever keybindings you prefer.

crux-open-with

crux-smart-kill-line

crux-smart-open-line-above

crux-smart-open-line

crux-cleanup-buffer-or-region

crux-recentf-find-file

crux-recentf-find-directory

crux-view-url

crux-eval-and-replace

crux-transpose-windows

crux-delete-file-and-buffer

crux-copy-file-preserve-attributes

crux-duplicate-current-line-or-region

crux-duplicate-and-comment-current-line-or-region

crux-rename-file-and-buffer

crux-visit-term-buffer

ansi-term

crux-kill-other-buffers

crux-indent-defun

crux-indent-rigidly-and-copy-to-clipboard

crux-find-user-init-file

crux-find-user-custom-file

crux-find-shell-init-file

crux-top-join-line

crux-kill-whole-line

crux-kill-line-backwards

crux-kill-and-join-forward

crux-kill-buffer-truename

crux-ispell-word-then-abbrev

ispell

abbrev

crux-upcase-region

upcase-region

transient-mark-mode

crux-downcase-region

downcase-region

transient-mark-mode

crux-capitalize-region

capitalize-region

transient-mark-mode

crux-other-window-or-switch-buffer

Here's how you'd bind some of the commands to keycombos:

(global-set-key [remap move-beginning-of-line] #'crux-move-beginning-of-line)
(global-set-key (kbd "C-c o") #'crux-open-with)
(global-set-key [(shift return)] #'crux-smart-open-line)
(global-set-key (kbd "s-r") #'crux-recentf-find-file)
(global-set-key (kbd "C-") #'crux-kill-line-backwards)
(global-set-key [remap kill-whole-line] #'crux-kill-whole-line)

For

crux-ispell-word-then-abbrev

(setq save-abbrevs 'silently)
(setq-default abbrev-mode t)

Using the bundled advices

crux ships with some handy advises that can enhance the operation of existing commands.

(crux-with-region-or-buffer)

You can use

crux-with-region-or-buffer

(crux-with-region-or-buffer indent-region)
(crux-with-region-or-buffer untabify)

(crux-with-region-or-line)

Likewise, you can use

crux-with-region-or-line

(crux-with-region-or-line comment-or-uncomment-region)

(crux-with-region-or-point-to-eol)

Sometimes you might want to act on the point until the end of the current line, rather than the whole line, in the absence of a region:

(crux-with-region-or-point-to-eol kill-ring-save)

Minor modes

(crux-reopen-as-root-mode)

Crux provides a

crux-reopen-as-root

find-file

License

Copyright © 2015-2021 Bozhidar Batsov and contributors.

Distributed under the GNU General Public License; type C-h C-c to view it.