An open API service indexing awesome lists of open source software.

https://github.com/dhth/tomo

A no-frills pomodoro progress indicator for terminal multiplexers
https://github.com/dhth/tomo

pomodoro pomodoro-timer

Last synced: 4 months ago
JSON representation

A no-frills pomodoro progress indicator for terminal multiplexers

Awesome Lists containing this project

README

          


tomo



Build status
crates.io
Latest Release
Commits Since Latest Release

✨ Overview
---

`tomo` is a no-frills pomodoro progress indicator intended for tmux and similar
terminal multiplexers.

⚡️ Usage
---

### Basic Usage

```text
Usage: tomo [OPTIONS] [COMMAND]

Commands:
start Start a pomodoro timer
stop Stop timer
break Start a break
help Print this message or the help of the given subcommand(s)

Options:
-p, --pending-block String to represent a "pending" block in the progress bar [default: ▫]
-c, --complete-block String to represent a "complete" block in the progress bar [default: ▪]
-l, --left-pad String to pad the output with on the LHS [default: " "]
-r, --right-pad String to pad the output with on the RHS [default: " "]
-d, --delimiter Delimiter between progress bar chunks [default: ]
-n, --num-blocks Number of blocks to show in progress bar [default: 10]
--finished-msg Message to show when timer is finished [default: done]
--break-msg Message to show when on a break [default: \o/]
-h, --help Print help
```

### Changing the appearance of the progress bar

```bash
tomo -l='[ ' -r=' ]'
# [ ▪▪▪▪▪▫▫▫▫▫ ]

tomo -p='⣀' -c='⣿' -n=20
# ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣀⣀⣀⣀⣀
```

### Start tracking with time already elapsed

```bash
tomo start --elapsed-mins 10
```

### Displaying progress bar in tmux's status bar

Add the following to your tmux config (or modify it accordingly).

```
set -g status-right "#(tomo)"
```