Obsidian Github Copilot Plugin

Use Github Copilot in the Obsidian editor. This plugin is a bridge between the Obsidian editor and the Github Copilot service.

Requirements

• A Github Copilot subscription (https://copilot.github.com/)
• Node.js 18 or later
• Network connection to send and receive data from the Github Copilot service

Installation

1. Install the plugin via the Obsidian community plugins browser.
2. Go to the plugin settings and enter the path to the Node +18 binary. You can find it by running which node in your terminal.
3. Either
   1. A modal will appear asking you to sign in to Copilot. Follow the instructions to sign in.
   2. Or, you will receive a notice saying that Copilot is ready to use. (This will happen if you have already signed in to Copilot in the past in IDEs)

Note

If you install the plugin by cloning it or downloading the release files from Github, you will need to name the plugin folder github-copilot for the plugin to work.

Usage

1. Open a note in Obsidian.
2. Write something in the editor.
3. After a small pause, Copilot will suggest completions for your text.
4. Press Tab to accept a suggestion or Esc to dismiss it.

Features

• Use Github Copilot in the Obsidian editor
• Configure the suggestion generation delay
• Configure your bindings to accept, dismiss, trigger or partially accept suggestions
• Configure if you want to see automatic suggestions or only trigger them manually
• Configure if you want to see suggestion only in code blocks or in the whole note
• Exclude folders and files from the suggestion generation

Known issues

• If you installed Obsidian with Flatpak, you might need to use NVM to handle Node.js versions as the default binary path is not accessible in the Flatpak sandbox. See this issue for more information.