GitHub Copilot

unlisted

by Alexandre Baron

Intégration de GitHub Copilot pour l'autocomplétion intelligente dans Obsidian

View on GitHub

Obsidian GitHub Copilot Plugin

Plugin Obsidian qui intègre une fonctionnalité similaire à GitHub Copilot pour l'autocomplétion intelligente de vos notes.

Fonctionnalités

  • ✨ Autocomplétion intelligente : Suggestions automatiques pendant que vous tapez
  • 🎯 Suggestions manuelles : Demandez une suggestion à tout moment avec une commande
  • ⚙️ Personnalisable : Configurez le comportement selon vos préférences
  • 🔒 Respect de la vie privée : Utilisez votre propre clé API

Installation

Installation manuelle

  1. Téléchargez les fichiers du plugin
  2. Créez un dossier obsidian-copilot dans votre dossier .obsidian/plugins/
  3. Copiez les fichiers main.js, manifest.json, et styles.css dans ce dossier
  4. Rechargez Obsidian
  5. Activez le plugin dans les paramètres

Installation pour développement

# Cloner ou copier les fichiers dans votre dossier de plugins
cd /path/to/your/vault/.obsidian/plugins/
mkdir obsidian-copilot
cd obsidian-copilot

# Installer les dépendances
npm install

# Compiler le plugin
npm run build

# Ou mode développement avec watch
npm run dev

Configuration

  1. Ouvrez les paramètres d'Obsidian
  2. Allez dans "Community plugins" → "Obsidian GitHub Copilot"
  3. Entrez votre clé API OpenAI
  4. Configurez les paramètres selon vos préférences :
    • Activer Copilot : Active/désactive le plugin
    • Déclenchement automatique : Suggestions automatiques pendant la frappe
    • Caractères minimum : Nombre de caractères avant déclenchement (1-10)
    • Délai : Temps d'attente avant suggestion (100-2000ms)

Utilisation

Suggestions automatiques

Si le déclenchement automatique est activé, le plugin suggérera automatiquement du texte après que vous ayez tapé le nombre minimum de caractères configuré.

Suggestions manuelles

Utilisez la commande "Obtenir une suggestion" depuis la palette de commandes (Ctrl/Cmd+P) ou configurez un raccourci clavier.

Activer/Désactiver rapidement

  • Cliquez sur l'icône 🤖 dans la barre latérale
  • Utilisez la commande "Activer/Désactiver Copilot"

Commandes

  • Activer/Désactiver Copilot : Active ou désactive le plugin
  • Obtenir une suggestion : Demande une suggestion manuelle

Note importante

Ce plugin utilise l'API OpenAI par défaut. Vous devez avoir un compte OpenAI et une clé API valide. Des frais peuvent s'appliquer selon votre utilisation.

Si vous avez accès à l'API GitHub Copilot, vous pouvez modifier le code dans main.ts pour utiliser cette API à la place.

Développement

Le plugin est écrit en TypeScript et utilise :

  • Obsidian API
  • esbuild pour la compilation
  • TypeScript pour le typage

Structure des fichiers

  • main.ts : Code principal du plugin
  • manifest.json : Métadonnées du plugin
  • styles.css : Styles CSS
  • esbuild.config.mjs : Configuration de build
  • tsconfig.json : Configuration TypeScript

Limitations

  • Nécessite une connexion internet
  • Requiert une clé API OpenAI (payante après quota gratuit)
  • Les suggestions dépendent de la qualité du modèle AI utilisé

Licence

MIT

Contribuer

Les contributions sont les bienvenues ! N'hésitez pas à ouvrir une issue ou une pull request.

Support

Si vous rencontrez des problèmes ou avez des questions, veuillez ouvrir une issue sur GitHub.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.