# ⏳ Comodoro [](https://crates.io/crates/comodoro) [](https://matrix.to/#/#pimalaya.comodoro:matrix.org)
<https://pimalaya.org/comodoro/>
CLI to manage timers, based on [time-lib](https://git.sr.ht/~soywod/pimalaya/tree/master/item/time/README.md).
## Features
- Centralized server timer controllable by multiple clients at the same time
- Multi protocols (only TCP for now, but you can build your own)
- Cycles customizable via config file (Pomodoro style, 52/17 style, custom)
- 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/index.html) for other installation methods.*
</td>
</tr>
</table>
## Configuration
Please read the [documentation](https://pimalaya.org/comodoro/cli/configuration/index.html).
## Development
The development environment is managed by [Nix](https://nixos.org/download.html). Running `nix-shell` will spawn a shell with everything you need to get started with the lib: `cargo`, `cargo-watch`, `rust-bin`, `rust-analyzer`…
```sh
# start a Nix shell
$ nix-shell
# then build the CLI
$ cargo build -p comodoro
```
## Contributing
If you want to **report a bug** that [does not exist yet](https://todo.sr.ht/~soywod/pimalaya?search=status%3Aopen+label%3A%222%3Acomodoro%22), please send an email at [~soywod/pimalaya@todo.sr.ht](mailto:~soywod/pimalaya@todo.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). Follow [this guide](https://git-send-email.io/) to configure git properly.
If you just 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). You can also use the mailing list [[send an email](mailto:~soywod/pimalaya@lists.sr.ht)|[subscribe](mailto:~soywod/pimalaya+subscribe@lists.sr.ht)|[unsubscribe](mailto:~soywod/pimalaya+unsubscribe@lists.sr.ht)].
## Sponsoring
[](https://nlnet.nl/project/Himalaya/index.html)
Special thanks to the [NLnet foundation](https://nlnet.nl/project/Himalaya/index.html) and the [European Commission](https://www.ngi.eu/) that helped the project to receive financial support from:
- [NGI Assure](https://nlnet.nl/assure/) in 2022
- [NGI Zero Untrust](https://nlnet.nl/entrust/) in 2023
If you appreciate the project, feel free to donate using one of the following providers:
[](https://github.com/sponsors/soywod)
[](https://www.paypal.com/paypalme/soywod)
[](https://ko-fi.com/soywod)
[](https://www.buymeacoffee.com/soywod)
[](https://liberapay.com/soywod)