Timer suited for the pomodoro technique
Socket-based Client/Server-Architecture, where multiple clients can attach to a single timer server
Server is terminal independent and runs as a daemon
TUI-interface with keymaps + and a minimal TUI-interface
CLI commands to interact with the timer without attaching a client (e.g. for integration into tools such as tmux)

Example with multiple clients + display inside the left status bar of tmux

Installation

NOTE: The timer has currently only been tested on Mac and Linux, but might also work on Windows (please let me know if you tried it succesfully).

Homebrew

brew tap install on3iro/zentime brew install zentime

Cargo

cargo install zentime-rs

Nix

Coming soon

Configuration

The default location for the configuration file is /home/<user>/.config/zentime/zentime.toml. To get an overview of available configuration options please have a look at the example configuration.

For an overview of all available configuration keys, check out the docs. Note that each key (view, timers etc.) corresponds to the header of a toml table while clicking on the type inside the docs shows you the available configuration fields.

Tmux integration example

To display the current timer state inside the tmux status bar you could use zentime once which will be queried by tmux on each status bar update. Simply add the following snippet to your .tmux.conf:

conf set -g status-left " #(zentime once) "

If you would like to add shortcuts (e.g. to toggle pause/play) from inside tmux you could add bindings like this:

conf bind t run-shell "zentime toggle-timer > /dev/null" bind y run-shell "zentime skip > /dev/null"

TOC