39 lines
1.0 KiB
Markdown
39 lines
1.0 KiB
Markdown
# pomc: pomodoro daemon client
|
|
|
|
[](https://crates.io/crates/pomc)
|
|
|
|
This program provides a basic CLI client for the [pomd](https://github.com/exvacuum/pomd) pomodoro daemon.
|
|
|
|
## Installation
|
|
|
|
### Via crates.io
|
|
```sh
|
|
cargo install pomc
|
|
```
|
|
|
|
### From Source
|
|
```sh
|
|
cargo install --path .
|
|
```
|
|
|
|
## Usage
|
|
```
|
|
Usage: pomc <COMMAND>
|
|
|
|
Commands:
|
|
start Start the pomodoro timer
|
|
pause Pause the pomodoro timer
|
|
stop Stop the pomodoro timer
|
|
skip Skip the current timer
|
|
get-iteration Retrieve the current iteration of the pomodoro
|
|
get-remaining Get remaining timer duration (MM:SS)
|
|
is-running Get whether the timer is running
|
|
is-on-break Get whether the current timer is a break
|
|
help Print this message or the help of the given subcommand(s)
|
|
|
|
Options:
|
|
-h, --help Print help
|
|
-V, --version Print version
|
|
```
|
|
This program could be used in statusbars to monitor pomd status, as well as used directly from a terminal to control the timer.
|