Skip to content

Installation

Requirements

  • Emacs 29.1 or later.

  • compat 31.0.0.1 or later.

  • Jujutsu (jj) v0.41.0 or later installed and in your PATH.

  • magit 3.3.0 or later (for section management).

  • consult 1.0 or later and plz 0.9.1 or later (for native Gerrit completion).

  • transient 0.5.0 or later (popup menus).

  • with-editor (for descriptive message editing).

Installing from Git

Majutsu is currently available via GitHub. You can install it using your preferred Emacs package manager.

Doom Emacs

Add the following to your packages.el:

(package! majutsu :recipe (:host github :repo "0WD0/majutsu"))

use-package with straight.el

(use-package majutsu
  :straight (:host github :repo "0WD0/majutsu"))

use-package :vc (Emacs 30+)

The built-in use-package :vc keyword is available in Emacs 30 and later. Use :rev :newest to follow the repository's current default branch:

(use-package majutsu
  :vc (:url "https://github.com/0WD0/majutsu"
       :rev :newest))

package-vc (Emacs 29+)

Emacs 29 added built-in package-vc support. Install Majutsu directly, then configure it with use-package:

(unless (package-installed-p 'majutsu)
  (package-vc-install
   '(majutsu :url "https://github.com/0WD0/majutsu")))

(use-package majutsu)

Manual Installation

Clone the repository and add it to your load-path:

(add-to-list 'load-path "/path/to/majutsu")
(require 'majutsu)

Post-Installation Tasks

Vanilla: No keymap setup is required; Majutsu's native bindings are active as soon as its modes load.

Evil: Majutsu detects Evil, installs its normal-state integration by default, and opens Majutsu buffers in the configured Evil state. Customize this with M-x customize-group RET majutsu-evil RET.