QuentinGruber/pomodoro.nvim

github github
utility
stars 21
issues 0
subscribers 1
forks 1
CREATED

2024-09-08

UPDATED

10 days ago


pomodoro.nvim

Use the Pomodoro Technique in Neovim with built-in session tracking and break reminders.

image

Install using lazy.nvim

  {
    "quentingruber/pomodoro.nvim",
    lazy = false, -- needed so the pomodoro can start at launch
    opts = {
      start_at_launch = true,
      work_duration = 25,
      break_duration = 5,
      delay_duration = 1, -- The additionnal work time you get when you delay a break
      long_break_duration = 15,
      breaks_before_long = 4,
    },
  },

Setup pomodoro display in lualine

  {
    "nvim-lualine/lualine.nvim",
    optional = true,
    event = "VeryLazy",
    opts = function(_, opts)
      table.insert(opts.sections.lualine_x, 3, {
        function()
          return require("pomodoro").get_pomodoro_status()
        end,
      })
    end,
  },

Usage

Command Description
:PomodoroStart Start the Pomodoro timer.
:PomodoroStop Stop the Pomodoro timer.
:PomodoroUI Display the Pomodoro UI.
:PomodoroSkipBreak Skip the current break and start the next work session.
:PomodoroForceBreak Forcefully start a break.
:PomodoroDelayBreak Delay the current break by a delay duration.