Skip to content

Getting Started

Jump to bottom
Björn Platte edited this page Jan 16, 2026 · 1 revision

Getting Started

This guide will help you set up the GitHub Issues plugin for Obsidian.

Installation

Via Community Plugins (Recommended)

  1. Open Obsidian Settings
  2. Navigate to Community Plugins
  3. Click Browse and search for "GitHub Issues"
  4. Click Install and then Enable

Manual Installation

  1. Download the latest release from GitHub Releases
  2. Extract to <vault>/.obsidian/plugins/github-issues/
  3. Enable the plugin in Community Plugins
  4. Reload Obsidian

Create a GitHub Token

  1. Go to GitHub Settings → Developer Settings → Personal access tokens
  2. Click Generate new token (classic)
  3. Give it a name (e.g., "Obsidian GitHub Issues Plugin")
  4. Select the following scopes:
    • repo - Full control of private repositories
    • read:org - Read organization membership (for private repos)
    • read:project - Read access to projects (for GitHub Projects)
  5. Click Generate token
  6. Copy the token (you won't see it again!)

Configure the Plugin

Enter Your Token

  1. Open Obsidian Settings → GitHub Issues
  2. In the Authentication section:
    • Paste your token in the GitHub Token field, or
    • Enable Use SecretStorage (recommended, requires Obsidian 1.11+) for secure storage

SecretStorage (Recommended)

SecretStorage uses Obsidian's Keychain to store your token securely:

  1. Enable Use SecretStorage
  2. Click Create new secret
  3. Enter a name and paste your token
  4. The token is now stored securely

If you have an existing token, use Migrate to Keychain to move it to secure storage.

Add Your First Repository

Option 1: Load from GitHub

  1. Click Load Repositories
  2. Select repositories from the list
  3. Click Add Selected Repositories

Option 2: Add Manually

  1. Click Add Repository Manually
  2. Enter the repository in owner/repo format (e.g., LonoxX/obsidian-github-issues)
  3. Press Enter

Run Your First Sync

After adding a repository:

  1. Click the Sync button in the ribbon (left sidebar), or
  2. Use the command Sync GitHub issues & pull requests

Your issues and pull requests will be created as markdown files in your vault.

Next Steps

Clone this wiki locally