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-watcher

This 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)

Post-Installation Setup

After installing Mac Watcher, you need to set it up:

  1. Run the setup command to create the necessary configuration files:

    mac-watcher --setup

    This 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
  2. Configure Mac Watcher according to your preferences:

    mac-watcher --config

    This 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)
  3. Start the sleepwatcher service to enable wake detection:

    brew services start sleepwatcher

    Note: If you've already run the setup command and see that sleepwatcher is already running, you can skip this step.

  4. (Optional) Test the functionality:

    mac-watcher --test

Verification

To verify that Mac Watcher is installed and configured correctly, run:

mac-watcher --diagnostics

This will check all components and dependencies to ensure everything is working properly.

Available Commands

Mac Watcher provides several command-line options:

CommandShort FormDescription
--help-hDisplay help information
--dependencies-dCheck and install dependencies
--setup-sSet up .wakeup file and default configuration
--config-cCustomize configuration
--test-tRun the monitor script manually for testing
--diagnostics-DCheck current setup
--instructions-iShow detailed instructions
--version-vDisplay version information