Skip to content

Repository files navigation

tmux-flow

Display Flow pomodoro timer status in your tmux status bar.

CI Release License: MIT

Dependencies

  • macOS with Flow installed

Installation

Add this plugin to your ~/.tmux.conf:

set -g @plugin 'tmux-contrib/tmux-flow'

And install it by running <prefix> + I.

Usage

Add the #{flow} format string to your status bar:

set -g status-right "#{flow} | %H:%M"

Configuration

Option Default Description
@flow-focus-icon "" Icon for focus sessions
@flow-break-icon "" Icon for break periods

Format Strings

Format String Description
#{flow} Current Flow phase and remaining time

Development

Prerequisites

Install dependencies using Nix:

nix develop

Or install manually: bash, tmux, bats

Running Tests

bats tests/

Debugging

Enable trace output with the DEBUG environment variable:

DEBUG=1 /path/to/tmux-flow/scripts/tmux_flow.sh

License

MIT

About

Display Flow pomodoro timer status in your tmux status bar

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Contributors

Languages