https://github.com/lighttigerxiv/caffeine-cli
A caffeine cli app to keep the screen awake. (Linux Only)
https://github.com/lighttigerxiv/caffeine-cli
caffeine cli linux rust timer
Last synced: about 1 year ago
JSON representation
A caffeine cli app to keep the screen awake. (Linux Only)
- Host: GitHub
- URL: https://github.com/lighttigerxiv/caffeine-cli
- Owner: lighttigerXIV
- License: mit
- Created: 2025-01-29T11:35:20.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-30T20:04:50.000Z (over 1 year ago)
- Last Synced: 2025-06-06T12:20:30.691Z (about 1 year ago)
- Topics: caffeine, cli, linux, rust, timer
- Language: Rust
- Homepage: https://crates.io/crates/caffeine-cli
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ☕ Caffeine Cli
Just another caffeine tool, but this one should work. It uses systemd inhibit to manage the idling part.
# How To Install
To install run:
```bash
cargo install caffeine-cli
```
Alternatively you can manually download the release binary in the [releases](https://github.com/lighttigerXIV/caffeine-cli/releases) page.
# Usage
To install it as you can use cargo to add it or manually add the library in cargo.toml:
```bash
cargo add caffeine-cli
```
To add it in the cargo.toml:
```toml
caffeine-cli = "1.0.1"
```
You can also use this as a library:
To start and get a session you can use the init_session command:
```rust
// Starts an endless session
let session = init_session(None).unwrap();
// Starts with a protected session (no other sessions can be created if there's an active session)
let session = init_protected_session(None).unwrap();
// For a timed session (seconds)
let session = init_session(Some(4 * 60)).unwrap();
// Starts with a timed protected session
let session = init_protected_session(Some(4 * 60)).unwrap();
```
To end a session:
```rust
// Ends the given session
end_session(session);
// Ends the current protected session
end_protected_session();
```
# Commands
You can run the following commands:
`caffeine-cli {command}`
| Command | Description |
| ------- | ------------------------------------------------------------- |
| enable | Enables the caffeine session with an infinnite amount of time |
| timed | Enables the caffeine session with x amount of minutes |
| disable | Disables the current session |
| status | Shows the status of the current session |
Alternatively you can run the app and select the options in the menu:
