What is this?

A pomodoro timer for your system bar, intended for Waybar!

I have not tested other status bars, but hopefully it should also work for others. Waybar accepts a json with various data to display info for a module. If your bar also accepts json, then maybe it'll work the same as it does on Waybar.

It follows the same rules as pomodoro: 4 cycles of work and short breaks, followed by a long break.

How to use

• compile & install binary

git clone [email protected]:Andeskjerf/waybar-module-pomodoro.git
cd waybar-module-pomodoro
cargo build --release

Place the file in a folder you have in your $PATH. E.g /home/user/.local/bin

cp target/release/waybar-module-pomodoro ~/.local/bin

• add to ~/.config/waybar/config

"custom/pomodoro": {
	"format": "{}",
	"return-type": "json",
	"exec": "waybar-module-pomodoro",
	"on-click": "waybar-module-pomodoro toggle",
	"on-click-right": "waybar-module-pomodoro reset",
},

Include the module in your bar and you're set!

You can check how many pomodoros you've completed this session by hovering the module and checking its tooltip.

Options / arguments?

usage: waybar-module-pomodoro [options] [operation]
    options:
        -h, --help                  Prints this help message
        -v, --version               Prints the version string
        -w, --work <value>          Sets how long a work cycle is, in minutes. default: 25
        -s, --shortbreak <value>    Sets how long a short break is, in minutes. default: 5
        -l, --longbreak <value>     Sets how long a long break is, in minutes. default: 15

        -p, --play <value>          Sets custom play icon/text. default: ▶
        -a, --pause <value>         Sets custom pause icon/text. default: ⏸
        -o, --work-icon <value>     Sets custom work icon/text. default: 󰔟
        -b, --break-icon <value>    Sets custom break icon/text. default: 

        --no-icons                  Disable the pause/play icon
        --no-work-icons             Disable the work/break icon

        --autow                     Starts a work cycle automatically after a break
        --autob                     Starts a break cycle automatically after work
        --autor                     Restore timer to prior-state (even after shutdown)

    operations:
        toggle                      Toggles the timer
        start                       Start the timer
        stop                        Stop the timer
        reset                       Reset timer to initial state

CSS Styling

Valid classes:

""          -   timer has not yet been started
"pause"     -   timer has been paused
"work"      -   timer is currently in a work cycle
"break"     -   timer is currently in a break cycle, either a short or long one