Git Backup

A lightweight Obsidian desktop plugin for backing up a vault with Git.

Features

• Commit all vault changes with a customizable message format.
• Pull with rebase and push the main branch using standard Git commands.
• Show changed files, staged files, and commits ahead/behind the upstream branch.
• Display status in the bottom status bar and in an optional sidebar view.

Requirements

• Obsidian desktop 1.5.0 or newer.
• Git installed and configured outside the plugin.
• The vault initialized as a Git repository.
• A main branch with an origin remote for sync.

The plugin does not configure Git, manage credentials, or send vault data anywhere. It runs git status, git add, git commit, git pull --rebase, and git push in the vault directory.

Settings

The default commit message is:

Vault backup {{date}} {{time}}

Available placeholders are {{date}}, {{time}}, and {{branch}}.

Development

npm ci
npm run build
npm run lint

For local testing, copy main.js, manifest.json, and styles.css into <vault>/.obsidian/plugins/git-backup/, then enable the plugin in Obsidian.