Awaken

A command line tool that prevents your Mac from going to sleep.

Description

awaken is a re-implementation of the caffeinate command line tool included in macOS. The project includes a libawaken.a static library to embed this behavior in other applications, like my macOS application KeepingYouAwake.

Installation

awaken can be built and installed using the.meson build system and a clang compiler that supports C++23 (e.g. from a recent Xcode version). For convenience Swift Package Manager support is also provided.

meson build --buildtype=release
cd build
meson install
awaken —-help

Usage

awaken - prevents your Mac from going to sleep.
Usage:
  ./build/awaken [OPTION...]

  -d, --display-sleep    prevent the display from idle sleeping
  -s, --system-sleep     prevent the system from idle sleeping (default:
                         true)
  -t, --timeout N        timeout in seconds until the sleep assertion expires
                         (default: 0)
  -b, --battery-level N  a minimum battery level on devices with a built-in
                         battery that causes the sleep assertion to expire
                         (e.g. 20 for <= 20% remaining battery). Values above 95
                         are unreliable and depend on the battery health.
                         (default: 0)

 Help options:
  -h, --help     print this help
  -v, --version  print version information

Documentation

You can use doxygen (brew install doxygen) to generate the class documentation for this project.

License

All files in this project are covered by the MIT license.