https://github.com/Pierrad/obsidian-github-copilot

A bridge between Obsidian and Github Copilot
https://github.com/Pierrad/obsidian-github-copilot

ai completion copilot github github-copilot obsidian obsidian-md plugin

Last synced: 3 months ago
JSON representation

A bridge between Obsidian and Github Copilot

• Host: GitHub
• URL: https://github.com/Pierrad/obsidian-github-copilot
• Owner: Pierrad
• License: apache-2.0
• Created: 2024-03-31T11:53:07.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-07-13T07:31:27.000Z (6 months ago)
• Last Synced: 2024-07-14T07:53:18.399Z (6 months ago)
• Topics: ai, completion, copilot, github, github-copilot, obsidian, obsidian-md, plugin
• Language: JavaScript
• Homepage:
• Size: 13.5 MB
• Stars: 60
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - Pierrad/obsidian-github-copilot - A bridge between Obsidian and Github Copilot (JavaScript)

README

        
# Obsidian Github Copilot Plugin

![Obsidian plugin](https://img.shields.io/endpoint?url=https://scambier.xyz/obsidian-endpoints/github-copilot.json)

![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/pierrad/obsidian-github-copilot)

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

![https://github.com/Pierrad/obsidian-github-copilot/tree/master/.github/assets/example.gif](https://github.com/Pierrad/obsidian-github-copilot/blob/master/.github/assets/example.gif)

## 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

- [x] Use Github Copilot in the Obsidian editor

- [x] Configure the suggestion generation delay

- [x] Configure your bindings to accept, dismiss, trigger or partially accept suggestions

- [x] Configure if you want to see automatic suggestions or only trigger them manually

- [x] Configure if you want to see suggestion only in code blocks or in the whole note 

- [x] 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](https://github.com/Pierrad/obsidian-github-copilot/issues/6) for more information.