comodoro 0.0.5

CLI to manage your time using the Pomodoro technique.
Documentation 
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# 🍅 Comodoro [![Crates.io](https://img.shields.io/crates/v/comodoro)](https://crates.io/crates/comodoro) [![Matrix](https://img.shields.io/matrix/pimalaya.comodoro:matrix.org?color=success&label=chat)](https://matrix.to/#/#pimalaya.comodoro:matrix.org)

https://pimalaya.org/comodoro/

CLI to manage your time using the
[Pomodoro](https://en.wikipedia.org/wiki/Pomodoro_Technique)
technique, based on the
[pimalaya-pomodoro](https://sr.ht/~soywod/pimalaya/) library.

*Disclaimer: the project is under active development, do not use in
production before the `v1.0.0`.*

## Features

- Centralized server timer controllable by multiple clients at the
  same time
- Multi protocols (only TCP for now, but you can build your own)
- Work and break durations customizable via config file
- Server and timer hooks customizable via config file
- …

## Installation

<table align="center">
<tr>
<td width="50%">
<a href="https://repology.org/project/comodoro/versions">
<img src="https://repology.org/badge/vertical-allrepos/comodoro.svg" alt="Packaging status" />
</a>
</td>
<td width="50%">

```bash
# Cargo
$ cargo install comodoro

# Nix
$ nix-env -i comodoro
```

*See the
[documentation](https://pimalaya.org/comodoro/cli/installation.html)
for other installation methods.*

</td>
</tr>
</table>

## Configuration

Please read the
[documentation](https://pimalaya.org/comodoro/cli/configuration.html).

## Contributing

If you find a **bug** that [does not exist
yet](https://todo.sr.ht/~soywod/pimalaya), please send an email at
[~soywod/pimalaya@todo.sr.ht](mailto:~soywod/pimalaya@todo.sr.ht).

If you have a **question**, please send an email at
[~soywod/pimalaya@lists.sr.ht](mailto:~soywod/pimalaya@lists.sr.ht).

If you want to **propose a feature** or **fix a bug**, please send a
patch at
[~soywod/pimalaya@lists.sr.ht](mailto:~soywod/pimalaya@lists.sr.ht)
using [git send-email](https://git-scm.com/docs/git-send-email) (see
[this guide](https://git-send-email.io/) on how to configure it).

If you want to **subscribe** to the mailing list, please send an email
at
[~soywod/pimalaya+subscribe@lists.sr.ht](mailto:~soywod/pimalaya+subscribe@lists.sr.ht).

If you want to **unsubscribe** to the mailing list, please send an
email at
[~soywod/pimalaya+unsubscribe@lists.sr.ht](mailto:~soywod/pimalaya+unsubscribe@lists.sr.ht).

If you want to **discuss** about the project, feel free to join the
[Matrix](https://matrix.org/) workspace
[#pimalaya.comodoro](https://matrix.to/#/#pimalaya.comodoro:matrix.org)
or contact me directly
[@soywod](https://matrix.to/#/@soywod:matrix.org).

## Credits

- [Francesco Cirillo](https://francescocirillo.com/), the creator of
  the Pomodoro technique
- [Wikipedia](https://en.wikipedia.org/wiki/Pomodoro_Technique)
- [pomodoro-technique.fr](http://www.pomodoro-technique.fr/)
- [pymodoro](https://github.com/rogeralmeida/pymodoro), a python CLI

## Sponsoring

[![GitHub](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/soywod)
[![PayPal](https://img.shields.io/badge/-PayPal-0079c1?logo=PayPal&logoColor=ffffff)](https://www.paypal.com/paypalme/soywod)
[![Ko-fi](https://img.shields.io/badge/-Ko--fi-ff5e5a?logo=Ko-fi&logoColor=ffffff)](https://ko-fi.com/soywod)
[![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ffdd00?logo=Buy%20Me%20A%20Coffee&logoColor=000000)](https://www.buymeacoffee.com/soywod)
[![Liberapay](https://img.shields.io/badge/-Liberapay-f6c915?logo=Liberapay&logoColor=222222)](https://liberapay.com/soywod)