obsidian-git
obsidian-git copied to clipboard
Backup your Obsidian.md vault with git
Obsidian Git
Simple plugin that allows you to back up your Obsidian.md vault to a remote git repository (e.g. private repo on GitHub). This plugin assumes credentials are set up.
On advantages of backing up your vault with git I suggest reading this amazing article by @tallguyjenks.
Mobile support
For mobile usage please install the Obsidian Git Mobile plugin instead.
Installation
⚠ Installing Obsidian via Snap on Linux is not supported. Please use AppImage or Flatpak instead (Linux installation guide)
See the installation guide for further instructions.
Documentation
Requirements, tips and tricks, common issues and more can be found in the wiki
Features
- Automatic vault backup every X minutes
- Pull changes from remote repository on Obsidian startup
- Assign hotkeys for pulling/pushing changes to a remote repository
- Manage different repositories via Git submodules
Sidebar view
The Source Control View allows you to stage and commit individual files. It can be opened by the Open Source Control View
command.
Available Commands
-
Create Backup
: Commits all changes and pushes them depending on your setting whether to push on backup or not -
Create Backup with specific message
: Same as above, but with a custom message -
Commit all changes
: Only commits all changes without pushing -
Commit all changes with specific message
: Same as above, but with a custom message -
Push
-
Pull
-
List changed files
: Lists all changes in a modal -
Edit remotes
andRemove remote
-
Initialize
a new repo` -
Clone an existing remote repo
Contact
If you have any kind of feedback or questions, feel free to reach out via GitHub issues or @Vinadon
on Obsidian Discord server.
This plugin was initial developed by denolehov. Since March 2021, it is Vinzent03 who is developing on this plugin.
If you want to support me (Vinzent03) you can support me on Ko-fi