Quick GitHub Sync
M1LLKY85 downloadsSync your vault with a GitHub repository in one click.
- Overview
- Scorecard
- Updates1
An Obsidian plugin that syncs your vault with a GitHub repository in one click.
Features
- One-click sync via ribbon button or Command Palette
- Pulls remote changes before pushing local ones
- Automatically detects the current branch
- PAT token is stored securely outside the vault using Obsidian's local storage API — it will never be committed to git
Requirements
- Git installed on your system
- Your vault must be a git repository (
git initinside the vault folder) - A GitHub repository to sync with
- A GitHub Personal Access Token with
reposcope
Installation
Manual
- Download
main.jsandmanifest.jsonfrom the latest release - Create a folder
quick-github-syncinside your vault's.obsidian/plugins/directory - Place the downloaded files inside that folder
- Enable the plugin in Obsidian: Settings → Community plugins → Quick GitHub Sync
Configuration
Go to Settings → Quick GitHub Sync and fill in:
| Field | Description |
|---|---|
| Repository URL | HTTPS URL of your GitHub repo (e.g. https://github.com/username/repo.git) |
| Personal Access Token | GitHub PAT with repo scope |
Usage
Click the cloud upload icon in the left ribbon, or run Sync vault with GitHub from the Command Palette (Ctrl+P).
The plugin will:
- Pull changes from the remote repository
- Stage all local changes
- Commit with a timestamp (
Obsidian Auto Sync DD/MM/YYYY, HH:MM:SS) - Push to the remote repository
License
HealthExcellent
ReviewSatisfactory
About
Sync your vault with a GitHub repository in one click from the ribbon or Command Palette. Pull remote changes before pushing local commits, auto-detect the current branch, and keep your GitHub PAT stored securely in Obsidian's local storage so it won't be committed.Details
Current version
1.0.2
Last updated
2 months ago
Created
2 months ago
Updates
1 release
Downloads
85
Compatible with
Obsidian 0.15.0+
Platforms
Desktop only
License
MIT
Author