Installation

To enable Org-roam’s protocol extensions, simply add the following to your init file:

(require 'org-roam-protocol)

We also need to set up org-protocol: the instructions for setting up org-protocol are reproduced here.

On a high-level, external calls are passed to Emacs via emacsclient. org-protocol intercepts these and runs custom actions based on the protocols registered. Hence, to use org-protocol, once must:

1. launch the emacsclient process
2. Register org-protocol:// as a valid scheme-handler

The instructions for the latter for each operating system is detailed below.

• Linux
• Mac OS
• Windows