keepawake-rs

Keep your computer awake. Like caffeinate, systemd-inhibit/gnome-session-inhibit, or PowerToys Awake, but cross-platform and written in Rust.

Also available as a Rust crate, and as a C library (experimental).

Usage

Keep your computer awake

Usage: keepawake [OPTIONS] [COMMAND]...

Arguments:
  [COMMAND]...  Run the command and wait for it to exit, keeping the computer awake while it runs

Options:
  -d, --display              Keep display on
  -i, --idle                 Keep system from idle sleeping
  -s, --sleep                Keep system from explicitly sleeping (Functionality and conditions for this to work vary by OS)
      --completions <SHELL>  Generate shell completions [possible values: bash, elvish, fish, powershell, zsh]
  -w <PID>                   Wait for the process with the specified pid to exit. This option is ignored when used with the COMMAND argument
  -h, --help                 Print help information
  -V, --version              Print version information

See docs.rs/keepawake for library crate documentation and usage.

Installation

Cargo

cargo install keepawake -F bin

Binaries

Download from https://github.com/segevfiner/keepawake-rs/releases/latest.

Completions

Use: keepawake --completions <SHELL> to generate a completion script, you will have to install it as appropriate for the specific shell you are using.

C library (experimental)

Built using cargo-c.

# build the library, create the .h header, create the .pc file
$ cargo cbuild --destdir=${D} --prefix=/usr --libdir=/usr/lib64

# build the library, create the .h header, create the .pc file and install all of it
$ cargo cinstall --destdir=${D} --prefix=/usr --libdir=/usr/lib64

See the generated header file for details on the API. See cargo-c for futher details on cargo-c usage.

Technical Details

	Windows	macOS	Linux
API	SetThreadExecutionState	IOPMAssertionCreateWithName	org.freedesktop.ScreenSaver & systemd Inhibitor Locks
Debug command	powercfg /requests	pmset -g assertions	systemd-inhibit --list, gnome-session-inhibit --list
display	ES_DISPLAY_REQUIRED	PreventUserIdleDisplaySleep	org.freedesktop.ScreenSaver.Inhibit
idle	ES_SYSTEM_REQUIRED	PreventUserIdleSystemSleep	org.freedesktop.login1.Manager.Inhibit("idle")
sleep	ES_AWAYMODE_REQUIRED	PreventSystemSleep	org.freedesktop.login1.Manager.Inhibit("sleep")

idle prevents the system from going to sleep on an idle timer, while sleep tries to prevent the system from going to sleep explicitly by the user (Whether sleep also prevents idle sleep varies by OS). sleep is restricted and will only work under certain conditions, most notably, the computer must be on AC power (AKA plugged in, not on battery), and is not allowed on Windows on any computer that has modern standby on (Which is unfortunate as modern standby is also used in laptops not only in handheld mobile devices).

Notes

Preventing the computer from explicitly sleeping, and/or by closing the lid, is often restricted in various ways by the OS, e.g. Only on AC power, not in any PC running Windows with Modern Standby. Also note that Modern Standby ignores/terminates power requests on DC (Battery) power, PowerSetRequest - Remarks.

License

MIT License.