https://github.com/dhth/tomo

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

pomodoro pomodoro-timer

Last synced: 18 days ago
JSON representation

A no-frills pomodoro progress indicator for terminal multiplexers

• Host: GitHub
• URL: https://github.com/dhth/tomo
• Owner: dhth
• License: mit
• Created: 2024-08-07T16:31:39.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-12-09T18:55:52.000Z (26 days ago)
• Last Synced: 2024-12-10T23:34:18.179Z (25 days ago)
• Topics: pomodoro, pomodoro-timer
• Language: Rust
• Homepage:
• Size: 73.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tomo

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/dhth/tomo/build.yml?style=flat-square)](https://github.com/dhth/tomo/actions)

[![Crates.io Version](https://img.shields.io/crates/v/tomo?style=flat-square)](https://crates.io/crates/tomo)

[![Latest Release](https://img.shields.io/github/release/dhth/tomo.svg?style=flat-square&label=github%20release)](https://github.com/dhth/tomo/releases/latest)

[![Commits Since Latest Release](https://img.shields.io/github/commits-since/dhth/tomo/latest?style=flat-square)](https://github.com/dhth/tomo/releases)

✨ 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)"

```