gitmyhub

obsidian-git

TypeScript ★ 11k updated 5d ago

Integrate Git version control with automatic commit-and-sync and other advanced features in Obsidian.md

A plugin for the Obsidian note-taking app that adds Git version control, letting you automatically back up and sync your notes to GitHub or another remote on a schedule, no terminal required.

TypeScriptisomorphic-gitsetup: moderatecomplexity 2/5

Obsidian Git is a community-made plugin for Obsidian.md, a note-taking application that stores your notes as plain text files in a folder on your computer called a vault. This plugin adds Git support directly inside Obsidian. Git is a version control system that tracks changes to files over time, lets you go back to earlier versions, and can sync files with online services like GitHub.

The core feature is automatic commit-and-sync on a schedule. You set a time interval, and the plugin will periodically save a snapshot of your vault, pull any changes from a remote location, and push your local changes out. This means your notes are continuously backed up and kept in sync across devices without you having to think about it. On startup, Obsidian can also pull the latest changes automatically.

For people who want more control, the plugin provides a Source Control panel inside Obsidian where you can see exactly which files changed, stage individual files (marking them as ready to include in a snapshot), review the differences line by line, and write your own snapshot message before saving. There is also a History panel that shows a log of past snapshots and which files changed in each one, and a Diff View that shows a side-by-side comparison of the current and previous version of any file.

Desktop use is stable and well-supported. Mobile use (iOS and Android) is experimental and comes with significant warnings in the README. On mobile, the plugin relies on a JavaScript reimplementation of Git called isomorphic-git rather than a native Git installation, and that approach has real limitations: no SSH authentication, memory constraints that can cause crashes on large vaults, and no support for submodules or certain merge strategies. The author explicitly notes that mobile may not work for everyone and that filing issues will not result in fixes for the underlying causes.

Installation is through Obsidian's community plugin browser. Full documentation, authentication setup guides, and Linux-specific notes live in the linked external documentation site.

Where it fits