obsidian-git README

The project's README from github.com/Vinzent03/obsidian-git. As one markdown file: README.md.

Obsidian Git Plugin

A powerful community plugin for Obsidian.md that brings Git integration right into your vault. Automatically commit, pull, push, and see your changes — all within Obsidian.

📚 Documentation

All setup instructions (including mobile), common issues, tips, and advanced configuration can be found in the 📖 full documentation.

Mobile users: The plugin is highly unstable ⚠️ ! Please check the dedicated Mobile section below.

Key Features

For detailed file history, consider pairing this plugin with the Version History Diff plugin.

UI Previews

🔧 Source Control View

Manage your file changes directly inside Obsidian like stage/unstage individual files and commit them.

Source Control View

📜 History View

Show the commit history of your repository. The commit message, author, date, and changed files can be shown. Author and date are disabled by default as shown in the screenshot, but can be enabled in the settings.

History View

🔍 Diff View

Compare versions with a clear and concise diff viewer. Open it from the source control view or via the Open diff view command.

Diff View

📝 Signs in the Editor

View line-by-line changes directly in the editor with added, modified, and deleted line/hunk indicators. You can stage and reset changes right from the signs. There also commands to navigate between hunks and stage/reset hunks under the cursor. Needs to be enabled in the plugin settings.

Signs

Available Commands

Not exhaustive - these are just some of the most common commands. For a full list, see the Command Palette in Obsidian.

💻 Desktop Notes

🔐 Authentication

Some Git services may require further setup for HTTPS/SSH authentication. Refer to the Authentication Guide

Obsidian on Linux

📱 Mobile Support (⚠️ Experimental)

The Git implementation on mobile is very unstable! I would not recommend using this plugin on mobile, but try other syncing services.

One such alternative is GitSync, which is available on both Android and iOS. It is not associated with this plugin, but it may be a better option for mobile users. A tutorial for setting it up can be found here.

🧪 The Git plugin works on mobile thanks to isomorphic-git, a JavaScript-based re-implementation of Git - but it comes with serious limitations and issues. It is not possible for an Obsidian plugin to use a native Git installation on Android or iOS.

❌ Mobile Feature Limitations

⚠️ Performance Caveats

[!caution] Depending on your device and available free RAM, Obsidian may

  • crash on clone/pull
  • create buffer overflow errors
  • run indefinitely.

It's caused by the underlying git implementation on mobile, which is not efficient. I don't know how to fix this. If that's the case for you, I have to admit this plugin won't work for you. So commenting on any issue or creating a new one won't help. I am sorry.

Tips for Mobile Use:

If you have a large repo/vault I recommend to stage individual files and only commit staged files.

🙋 Contact & Credits

☕ Support

If you find this plugin useful and would like to support its development, you can support me on Ko-fi.

ko-fi

obsidian-git (Vinzent03/obsidian-git)

Searching Database…

12.1K ·GitHub
Obsidian-git
What is this?Obsidian Git is a community plugin that brings Git version control right into Obsidian.md, letting you commit, pull, and push your vault changes from inside the app.
Is this a standalone app or does it run inside Obsidian?It's a plugin that runs inside the Obsidian app, adding a Source Control view, History view, Diff view, and editor gutter signs to your existing vault.
How do I start using it on my vault?Install it from Obsidian's community plugins, then initialize a new repo or clone an existing remote repo using the plugin's commands; from there you can use Commit-and-sync to commit, pull, and push on a schedule.
Do I need Git installed separately, or does it bring its own?On desktop the plugin relies on an installed native Git; on mobile it falls back to isomorphic-git, a JS re-implementation, since a real Git binary can't run there.
Does it work well on mobile?Mobile support is experimental and the author explicitly warns it is highly unstable, with crashes on clone/pull, no SSH auth, limited repo size, no rebase, and no submodules.
Does it work the same across Linux, macOS, and Windows?Yes on desktop, but on Linux the Snap build of Obsidian isn't supported and Flatpak is discouraged because of sandboxing restrictions; a package-manager install or AppImage is recommended instead.
Can I manage more than one Git repo from a single vault?Yes, it has opt-in submodule support for managing multiple repositories, but this is desktop-only.
Can I see line-by-line changes while editing a note?Yes, it can show added/modified/deleted line and hunk signs directly in the editor, with commands to stage or reset individual hunks.
Can I open a file's history on GitHub from inside Obsidian?Yes, there are commands to open the current file or its history directly on GitHub in your browser, though this only works on desktop.
What's a good alternative if mobile sync is too unstable for me?The author suggests GitSync, a separate unaffiliated app available on both Android and iOS, as a more reliable mobile syncing option.
What are similar projects?claudian, qiaomu-book-reader-legacy, yaos, vault-graph, quartz, open-knowledge, seafile, claude-obsidian
Which topics is it in?obsidian-md, obsidian-plugin, diff, history, obsidian, sync, version-control, knowledge-management, note-taking, github, git, plugin
Creator
Vinzent03
Size
5.6 MB
Stars
12.1K
Updated
CommitOct 14Release2.41.1Oct 02
Age
5y
Commits · 90 Days