corrected the Readme

This commit is contained in:
Pipo 2025-09-24 17:49:16 +02:00
parent db05c3eb7e
commit 2e9a4909e2

View file

@ -1,18 +1,17 @@
# auto-snapclean-listener
# SnapCleaner
A small macOS utility script that automatically deletes all local Time Machine snapshots once they are created.
It is useful for users who do not want macOS to keep local snapshots and prefer to rely only on external Time Machine backups.
SnapCleaner is a lightweight macOS tool that automatically deletes local Time Machine snapshots as soon as they are created.
It is designed for users who want to avoid local disk space being taken up by snapshots while still using Time Machine for external backups.
⚠️ Tested on **macOS Tahoe**. Other versions may work, but are not guaranteed.
⚠️ **Note**: SnapCleaner has been tested on **macOS Tahoe**. Other versions may work, but are untested.
---
## Features
- Listens for local Time Machine snapshot creation events.
- Waits until the backup process is finished (avoids conflicts).
- Automatically deletes all local snapshots afterwards.
- Lightweight: no constant polling, event-driven.
- Monitors for new Time Machine local snapshots
- Deletes snapshots automatically once they appear
- Waits until Time Machine finishes the backup process before deleting
- Runs silently in the background as a LaunchDaemon
---
@ -22,25 +21,33 @@ Clone the repository:
```bash
git clone https://git.lahmico.de/Pipo/snapcleaner.git
cd auto-snapclean-listener
cd snapcleaner
```
Make the script executable:
Run the installer:
```bash
chmod +x auto-snapclean-listener.sh
sudo ./install.sh
```
Install the LaunchDaemon:
This will:
- Copy the script `auto-snapclean-listener.sh` to `/usr/local/bin/`
- Install the LaunchDaemon `auto-snapclean-listener.plist` to `/Library/LaunchDaemons/`
- Load the service so it runs automatically whenever a local snapshot is created
---
## Uninstallation
To uninstall SnapCleaner:
```bash
sudo cp auto-snapclean-listener.plist /Library/LaunchDaemons/
sudo launchctl load /Library/LaunchDaemons/auto-snapclean-listener.plist
sudo ./uninstall.sh
```
Uninstall (if needed):
This will remove the LaunchDaemon and the installed script.
```bash
sudo launchctl unload /Library/LaunchDaemons/auto-snapclean-listener.plist
sudo rm /Library/LaunchDaemons/auto-snapclean-listener.plist
```
---
## License
SnapCleaner is released under the MIT License. See [LICENSE](LICENSE) for details.