Files
tmux-remind/README.md

1.6 KiB

tmux-remind

A tmux plugin that integrates with remind to display reminders and calendar views in tmux popups.

Features

  • Quick Reminders View: Display today's reminders in a centered popup (60% width/height)
  • Calendar View: Show a 2-week calendar overview in a full-screen popup (99% width/height)
  • Uses less for scrollable output with line position indicator

Requirements

  • remind - A sophisticated calendar and alarm program
  • tmux 3.2+ (for display-popup support)

Installation

With TPM (Tmux Plugin Manager)

Add to your ~/.tmux.conf:

set -g @plugin 'git@git.donadeo.net:pdonadeo/tmux-remind'

Reload tmux and press prefix + I to install.

Manual Installation

git clone https://git.donadeo.net/pdonadeo/tmux-remind.git ~/.tmux/plugins/tmux-remind

Add to your ~/.tmux.conf:

run-shell ~/.tmux/plugins/tmux-remind/tmux-remind.tmux

Usage

The plugin provides two keybindings:

Keybinding Action
prefix + r Show today's reminders in a popup
prefix + c Show 2-week calendar in a popup

Navigation

Both views use less for navigation:

  • j / k or arrow keys to scroll
  • q to close the popup
  • / to search
  • g to go to top, G to go to bottom

Configuration

The plugin uses your default remind configuration. Make sure you have your .reminders file set up in your home directory or configure remind accordingly.

License

MIT