Skip to content

Commit 193cb61

Browse files
author
Andrei
committed
Update README
1 parent 970d6b4 commit 193cb61

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# Git Guardian
22

3-
**Git Guardian** is a simple yet powerful CLI tool to automatically back up your project folders to GitHub. Designed for Mac users, Guardian watches your directories for changes or backs them up on a regular interval, committing and pushing changes automatically. It’s perfect for developers who want effortless version control without thinking about it.
3+
# Git Guardian
4+
5+
**Git Guardian** is a simple yet powerful CLI tool to automatically back up your project folders to GitHub. Designed for Mac users, Guardian watches your directories for changes or backs them up on a regular interval, committing and pushing changes automatically. It's perfect for developers who want effortless version control without thinking about it.
6+
7+
The CLI tool is called `guardian`.
8+
9+
---
10+
11+
## 🚀 Core Features
12+
13+
* **Auto-Backup:** Automatically commit and push changes to a GitHub repository.
14+
* **Watch Mode:** Monitor a folder for file changes and push updates with a configurable debounce time (e.g., every 30 seconds).
15+
* **Interval Mode:** Push all changes at a set interval (e.g., every 10 seconds to 5 minutes or more).
16+
* **Folder Management:** Link folders to Guardian with simple, user-friendly incremental IDs (1, 2, 3...).
17+
* **Colorful CLI:** Beautiful, color-coded terminal output with status indicators and icons.
18+
* **Listeners Dashboard:** View all active watchers with detailed info including mode, interval/debounce times, and last run timestamps.
19+
* **Flexible Paths:** Use relative paths (`.`, `..`) or absolute paths for linking and starting watchers.
20+
* **Autostart:** Guardian can start automatically when your Mac boots via launchd.
21+
* **Safe and Reliable:** Stops watchers if a folder is deleted and prevents duplicate or conflicting commits.
22+
* **Background Daemon:** Runs silently in the background, automatically managing all your linked folders.
423

524
The CLI tool is called `guardian`.
625

0 commit comments

Comments
 (0)