README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# pomc: pomodoro daemon client

[![Crates.io Version](https://img.shields.io/crates/v/pomc)](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.