https://github.com/segevfiner/keepawake-rs
Keep your computer awake
https://github.com/segevfiner/keepawake-rs
awake caffeinate gnome-session-inhibit idle power-management rust sleep systemd-inhibit
Last synced: 25 days ago
JSON representation
Keep your computer awake
- Host: GitHub
- URL: https://github.com/segevfiner/keepawake-rs
- Owner: segevfiner
- License: mit
- Created: 2022-09-27T13:56:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-15T11:54:19.000Z (about 2 months ago)
- Last Synced: 2025-04-12T19:49:31.127Z (25 days ago)
- Topics: awake, caffeinate, gnome-session-inhibit, idle, power-management, rust, sleep, systemd-inhibit
- Language: Rust
- Homepage: https://crates.io/crates/keepawake
- Size: 274 KB
- Stars: 31
- Watchers: 1
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# keepawake-rs
[](https://crates.io/crates/keepawake)
[](https://docs.rs/keepawake)
[](https://github.com/segevfiner/keepawake-rs/actions/workflows/ci.yml)
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](#c-library-experimental) (experimental).
[`caffeinate`]: https://ss64.com/osx/caffeinate.html
[`systemd-inhibit`]: https://www.freedesktop.org/software/systemd/man/systemd-inhibit.html
[`gnome-session-inhibit`]: https://manpages.ubuntu.com/manpages/jammy/man1/gnome-session-inhibit.1.html
[PowerToys Awake]: https://learn.microsoft.com/en-us/windows/powertoys/awake
[Rust]: https://www.rust-lang.org/
[Rust crate]: https://docs.rs/keepawake
## 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 Generate shell completions [possible values: bash, elvish, fish, powershell, zsh]
-w 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](https://docs.rs/keepawake) for library crate documentation and usage.
## Installation
### Cargo
```sh
cargo install keepawake -F bin
```
### Binaries
Download from https://github.com/segevfiner/keepawake-rs/releases/latest.
## Completions
Use: `keepawake --completions ` 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].
```sh
# build the library, create the .h header, create the .pc file
$ cargo cbuild --destdir=${D} --prefix=/usr --libdir=/usr/lib64
```
```sh
# 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.
[cargo-c]: https://crates.io/crates/cargo-c
## 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).
[`SetThreadExecutionState`]: https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setthreadexecutionstate
[`IOPMAssertionCreateWithName`]: https://developer.apple.com/documentation/iokit/1557134-iopmassertioncreatewithname
[`org.freedesktop.ScreenSaver`]: https://people.freedesktop.org/~hadess/idle-inhibition-spec/re01.html
[systemd Inhibitor Locks]: https://www.freedesktop.org/wiki/Software/systemd/inhibit/
## 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](https://learn.microsoft.com/en-us/windows-hardware/design/device-experiences/modern-standby). Also note that Modern Standby ignores/terminates power requests on DC (Battery) power, [PowerSetRequest - Remarks](https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-powersetrequest#remarks).
## License
MIT License.