Skip to content

gestylinaga/pomo.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 

Repository files navigation

πŸ… pomo.nvim

Simple Pomodoro Timer for NeoVim

✨ Installation

via lazy.nvim:

{
  "gestylinaga/pomo.nvim",
  dependencies = {
    "rcarriga/nvim-notify",
  },
  cmd = {
    "PomoStart",
    "PomoCheck",
    "PomoStop"
  },
  config = function()
    require("pomo").setup({
      -- config options go here --
    })
  end
}

πŸ› οΈ Configuration

-- Default config
require("pomo").setup({
  pomo_opts = {
    taskTime = 25,
    shortBreak = 5, -- or 10
    longBreak = 25,
  },
  notify_opts = {
    title = "Pomodoro Timer",
    icon = "πŸ…",
    render = "default", -- display style
    stages = "fade_in_slide_out", -- animation style
    timeout = 2500, -- time (in ms) popup stays on screen
  }
})

See nvim-notify for full list of notify options

⚑ Usage

  • Run :PomoStart to start the Pomodoro timer
  • The break timer will start automatically when the Pomodoro timer is done
  • Run :PomoStart again to start another interval
  • A long break will start automatically when 4 Pomodoro intervals have been completed
  • Run :PomoCheck anytime to see the remaining time on any timer
  • Run :PomoStop to stop the timer

Full Command List:

:PomoStart # starts timer
:PomoCheck # checks remaining time
:PomoStop  # stops timer

About

πŸ… A simple Pomodoro timer for Neovim

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages