obsidian-tracker
v1.0.1
Published
Automatically tracks and syncs Obsidian vaults with Git when Obsidian is running.
Readme
Obsidian Git Auto Tracker
A cross-platform Node.js tool that automatically tracks and syncs your Obsidian vaults with Git. It detects Obsidian vaults, watches for changes, auto-commits, and pushes updates when Obsidian is running.
Features
- Auto-detects Obsidian vaults on your system.
- Watches vaults for changes and auto-commits with customizable messages.
- Pushes to remote if configured.
- Platform support: Windows, macOS, Linux.
- Smart .gitignore for Obsidian and system files.
- Debounced change detection for efficient syncing.
- Auto-starts/stops tracking based on Obsidian process.
Installation
Clone this repository or copy the files to your machine.
Run the tracker:
node obsidian-git-tracker.js
Configuration
- The tool creates a
obsidian-tracker-config.jsonfile on first run. - You can edit this file to customize watched paths, commit messages, debounce time, etc.
Usage
- Start Obsidian and the tracker will automatically detect and sync your vaults.
- The tracker runs in the terminal and logs its actions.
- Press
Ctrl+Cto stop.
Requirements
- Node.js v16 or higher
- Git installed and available in your system PATH
License
MIT
