Installation Guide
Follow these steps to install and set up Mac Watcher on your system.
Prerequisites
Before installing Mac Watcher, ensure you have the following:
- macOS 10.15 (Catalina) or later
- Homebrew package manager installed
- Administrator privileges on your Mac
Installation Methods
The easiest way to install Mac Watcher is through Homebrew. This method automatically handles all dependencies.
brew install ramanaraj7/tap/mac-watcherThis command will install Mac Watcher and all required dependencies, including:
- sleepwatcher (for wake detection)
- jq (for JSON processing)
- imagesnap (for webcam capture)
- CoreLocationCLI (for location tracking)
- coreutils (for enhanced file and text utilities)
SHA256 Mismatch Error
- Using the latest formula:
brew updatebrew tap ramanaraj7/tapbrew install ramanaraj7/tap/mac-watcher - Building from source:
git clone https://github.com/ramanaraj7/mac-watcher.gitcd mac-watcherbrew install --build-from-source ./Formula/mac-watcher.rb
Post-Installation Setup
After installing Mac Watcher, you need to set it up:
Run the setup command to create the necessary configuration files:
mac-watcher --setupThis command will:
- Check for and install any missing dependencies
- Create the .wakeup file that runs when your Mac wakes from sleep
- Create a default configuration file
Configure Mac Watcher according to your preferences:
mac-watcher --configThis will open a menu with the following options:
- Email Settings
- Location & Network Settings
- Media Capture Settings
- Schedule Settings
- Storage Path Settings
- Timing Settings
- Auto-Delete Settings
- Login Detection Settings (Beta)
Start the sleepwatcher service to enable wake detection:
brew services start sleepwatcherNote: If you've already run the setup command and see that sleepwatcher is already running, you can skip this step.
(Optional) Test the functionality:
mac-watcher --test
Verification
To verify that Mac Watcher is installed and configured correctly, run:
mac-watcher --diagnosticsThis will check all components and dependencies to ensure everything is working properly.
Available Commands
Mac Watcher provides several command-line options:
| Command | Short Form | Description |
|---|---|---|
--help | -h | Display help information |
--dependencies | -d | Check and install dependencies |
--setup | -s | Set up .wakeup file and default configuration |
--config | -c | Customize configuration |
--test | -t | Run the monitor script manually for testing |
--diagnostics | -D | Check current setup |
--instructions | -i | Show detailed instructions |
--version | -v | Display version information |