tomate 0.5.0

A command-line tool for the Pomodoro productivity system
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

# Tomate

[![status-badge](https://ci.cosmicrose.dev/api/badges/1/status.svg)](https://ci.cosmicrose.dev/repos/1)
![Crates.io Version](https://img.shields.io/crates/v/tomate)
![Crates.io License](https://img.shields.io/crates/l/tomate)
![Crates.io Total Downloads](https://img.shields.io/crates/d/tomate)

A Pomodoro timer for the CLI

## Install

Clone this repository and run `cargo install`.

## Usage

To do a Pomodoro:

1. Start a Pomodoro with `tomate pomodoro start`
2. See remaining time with `tomate status`
3. End and archive the Pomodoro with `tomate pomodoro stop`

To take a break:

1. Start a break with `tomate short-break start`
2. See remaining time with `tomate status`
3. End the break with `tomate short-break stop`

### Description and tags

Provide an optional argument to `start` to give the Pomodoro a description.
You can also add tags with the `--tag` (`-t`) option.

```console
$ tomate pomodoro start -t work -t fun "Do something cool"
$ tomate status
Current Pomodoro: Do something cool
Status: Active
Duration: 25m
Tags:
        - work
        - fun

Time remaining: 24:22

(use "tomate pomodoro stop" to archive this Pomodoro)
```

### History

The `tomate history` command shows you all the Pomodoros you've completed.

```console
$ tomate history
 Date Started  Duration  Tags         Description
 01 Apr 10:23       25m  work         Emails
 01 Apr 11:04       25m  home         Phone calls
 01 Apr 11:43       25m  work,boring  More stuff
```

### Hooks

Tomate can run commands when timers start and stop.
Create an executable script in the hooks directory (by default `${XDG_CONFIG_DIR}/tomate/hooks`)
with any of the following names:

- `pomodoro-start`
- `pomodoro-end`
- `shortbreak-start`
- `shortbreak-end`
- `longbreak-start`
- `longbreak-end`

Make sure they are executable (`chmod u+x pomodoro-start`).

## Acknowledgements

Many thanks to Justin Campbell for his [Open Pomodoro](https://github.com/open-pomodoro/openpomodoro-cli) project.
It's good enough to rewrite it in Rust.

## License

Copyright © 2025 Rosa Richter

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.