caffeinate2

logo

caffeinate but it's written in Rust and has more options. Keeps your Mac wide awake.

Current Status

In development. Works fine, but I want to add more features and document the different types of sleep before version 1.0.0.

Installation

GitHub Releases

Download the latest release from here.

Homebrew

This won't be availible until version 1.0.0.

Cargo

cargo install caffeinate2

Usage

```plaintext Usage: caffeinate2 [OPTIONS] [COMMAND]...

Arguments: [COMMAND]... Wait for given command to complete (takes priority above timeout and pid)

Options: -v, --verbose Verbose mode --dry-run Dry run. Don't actually sleep. Useful for testing --drop-root Drop root privileges in command. Some programs don't want to work as root, but you need root to disable sleep entirely -d, --display Disable display sleep -m, --disk Disable disk idle sleep -i, --system Disable idle system sleep. Default if no other options are specified -s, --system-on-ac Disable system sleep while not on battery -e, --entirely Disable system sleep entirely (ignores lid closing) -u, --user-active Declare the user is active. If the display is off, this option turns it on and prevents it from going into idle sleep -t, --timeout Wait for X seconds. Also supports time units (like "1 day 2 hours 3mins 4s") -w, --waitfor Wait for program with PID X to complete -h, --help Print help -V, --version Print version ```

Sleep Timers (in order of priority)

Command

Sleep disabled until the command completes. You should enclose the command in quotes. Timeout and PID will be ignored if a command is specified.

caffeinate2 "echo hello"

Timeout and PID

Sleep disabled for a certain amount of time or until program with the specified PID completes. If both timeout and PID are specified, whichever was specified first will be used.

Timeout can either be a number of seconds or a duration string. For example you can pass -t 600 or -t 10m to wait for 10 minutes. You can create more descriptive durations, like -t "1 hour and 30 minutes", but it only looks at the first letter (so "3 movies" is just 3 minutes). Anything that's not a number followed by a letter will be ignored (the "and" in the previous example). YOU MUST USE QUOTATION MARKS FOR THIS TO WORK. Otherwise it will try to parse anything that's past the space as a command, and ignore the timeout.

caffeinate2 -t 600

caffeinate2 -t "1 hour and 30 minutes"

caffeinate2 -w 1234

None of the above

Sleep will be disabled until you press Ctrl+C.

caffeinate2

License

This project is licensed under the MIT License - see the license file for details.

TODO