Back to All Editors

Integration with Emacs

Install Boxes

• Install boxes using your system package manager (apt, brew etc) or build and install it yourself.

• Alternatively, adding the use-package form below to your startup file will instruct Emacs to automatically install the boxes binary using the system package manager if it’s not already installed.

• Note that boxes v2.1.0 is required to run boxes-command-on-region interactively due to requiring support for “-q (all)”. The other boxes commands work on all versions.

Install Emacs Package

The easiest way is to install the boxes package from MELPA, however it can also be installed manually if desired:

• Installation from MELPA

  1. Make sure MELPA is in your package archives list.

  2. M-x package-install boxes

  3. Add key bindings for the boxes commands to your startup file:

      (global-set-key "\C-cb" 'boxes-command-on-region)
      (global-set-key "\C-cq" 'boxes-create)
      (global-set-key "\C-cr" 'boxes-remove)
     

  4. Alternatively, if use-package is installed you can automatically install the boxes binary & elisp packages and add the key bindings with the following form, just like magic 😊

      (use-package boxes
        :ensure t
        :ensure-system-package boxes
        :bind (("C-c b" . boxes-command-on-region)
               ("C-c q" . boxes-create)
               ("C-c r" . boxes-remove)))
     

• Manual Installation

  1. Download boxes.el to a directory and add it to your load-path:

      (add-to-list 'load-path <install directory>)
     

  2. Add autoloads to your startup file so boxes will be loaded on first use:

      (autoload 'boxes-command-on-region "boxes" nil t)
      (autoload 'boxes-remove "boxes" nil t)
      (autoload 'boxes-create "boxes" nil t)
     

  3. Add key bindings for the boxes commands to your startup file:

      (global-set-key "\C-cb" 'boxes-command-on-region)
      (global-set-key "\C-cq" 'boxes-create)
      (global-set-key "\C-cr" 'boxes-remove)