obsidian-github-copilot  by Pierrad

Obsidian plugin for GitHub Copilot integration

created 1 year ago
308 stars

Top 88.2% on sourcepulse

GitHubView on GitHub
Project Summary

This plugin bridges Obsidian, a popular note-taking and knowledge management application, with GitHub Copilot, providing AI-powered code and text suggestions directly within the Obsidian editor. It targets Obsidian users who also leverage GitHub Copilot for productivity, enabling inline code/text completion and conversational AI assistance for their notes.

How It Works

The plugin integrates with the GitHub Copilot service via Node.js. For inline suggestions, it captures user input in the Obsidian editor and sends it to the Copilot backend for completion, displaying results inline. For chat functionality, it provides a sidebar interface to interact with various Copilot models, allowing users to query and manipulate their notes using natural language.

Quick Start & Requirements

  • Installation: Install via the Obsidian community plugins browser.
  • Prerequisites:
    • GitHub Copilot subscription.
    • Node.js 20 or later (ensure the binary path is configured in plugin settings).
    • Network connection to GitHub Copilot services.
  • Setup: Requires signing into GitHub Copilot via a modal or existing IDE authentication.
  • Docs: Obsidian GitHub Copilot Plugin

Highlighted Details

  • Inline suggestions for code and text within Obsidian notes.
  • GitHub Copilot Chat integration for AI-powered note summarization and querying.
  • Configurable suggestion delay, trigger methods, and scope (code blocks vs. entire note).
  • Support for excluding specific folders/files from suggestion generation.

Maintenance & Community

  • Active development is indicated by recent commits and open issues.
  • Community support channels are not explicitly mentioned in the README.

Licensing & Compatibility

  • The plugin itself appears to be under an unspecified license, but it relies on GitHub Copilot, which requires a paid subscription.
  • Compatibility with Obsidian's Flatpak installation might require specific Node.js handling due to sandbox limitations.

Limitations & Caveats

"Tab" completion can exhibit bugs in certain contexts like bullet points or LaTeX math, potentially due to plugin priority. Streaming responses for Copilot Chat are not yet implemented.

Health Check
Last commit

5 days ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
3
Star History
60 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.