Obsidian Auto Git

Obsidian Auto Git is a plugin for Obsidian that automates interactions with a Git repository, keeping your notes up to date across all your devices. The plugin automatically performs a pull on startup and a push at a defined interval, eliminating the need to manually manage synchronization.

Overview

The goal of this project is to make using Obsidian in a multi-device environment convenient and reliable while minimizing the risk of data loss and conflicts. The plugin works on top of Git and integrates with your Vault repository to ensure continuous synchronization of changes.

Features

• 🔄 Auto Pull on Start — automatically fetch changes when Obsidian starts.
• ⏱️ Scheduled Auto Push — automatically push changes at a specified interval.
• 🔧 Configurable Settings — adjust push interval, notifications, and more.
• 📦 Written in TypeScript — modern, readable code leveraging the Obsidian API.

Technologies Used

• TypeScript
• Node.js / npm
• Obsidian Plugin API
• Git (CLI)

Getting Started

To get started with Obsidian Auto Git, follow these steps:

1. Clone the repository:

   git clone https://github.com/NikitaBerezhnyj/OsidianAutoGit.git
   cd OsidianAutoGit
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

4. Prepare for usage:

   npm run prepare
   

5. Copy the generated plugin to your directory:

   <vault>/.obsidian/plugins/obsidian-auto-git
   

6. Enable the plugin in Obsidian settings.

Usage

Once the project is running, you can:

1. Configure the automatic push interval in the plugin settings.
2. View Git status in the status bar (if this feature is enabled).
3. Use Obsidian as usual — the plugin will keep the repository up to date automatically.
4. Customize commit behavior, logging, and other parameters if needed.

License & Community Guidelines

• License — project license.
• Code of Conduct — expected behavior for contributors.
• Contributing Guide — how to help the project.
• Security Policy — reporting security issues.