proffapt / pomodoro-cli

Almost the simplest pomodoro timer for *nix (Linux / Unix)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn

Note This project will not be maintained anymore simply because I have lost interest in it anymore.

POMODORO-CLI

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contact
  5. Acknowledgments
  6. Miscelleneous

About The Project

pomodoro-cli is the simplest possible pomodoro timer.

  • Linux image
  • macOS image

pomodoro-cli will notify you when it's time for a break, or time to focus.

(back to top)

Getting Started

Prerequisite

  • Zenity

Installation

git clone https://github.com/proffapt/pomodoro-cli
chmod +x install.sh
./install.sh

(back to top)

Usage


Usage: pd [options] focus break long_break breaks_until_long
options -h: display help message
focus Minutes of focus until break | Default = 25
break Minutes of break until focus | Default = 5
long_break Minutes of long break until focus | Default = 15
breaks_until_long Number of breaks until long break | Default = 4
apps_to_kill Apps to kill during focus time | Default = none

Examples

  • Start a pomodoro timer with 20 minutes of focus time
    pd 20
  • 20 minutes of focus time and 3 minutes of break time
    pd 20 3
  • 20 minutes of focus time, 3 minutes of break time and 10 minutes of long break
    pd 20 3 10
  • 20 minutes of focus time, 3 minutes of break time, 10 minutes of long break and 4 cicles of focus until long break
    pd 20 3 10 4
  • 20 minutes of focus time, 3 minutes of break time, 10 minutes of long break and 4 cycles of focus until long break. Disable Minecraft and Cheese during focus time. You need to enter the name of the apps you would use to start it through the terminal.(separated by commas)
    pd 20 3 10 4 minecraft,cheese

(back to top)

Contact

đź“« Arpit Bhardwaj ( aka proffapt ) - proffapt's Twitter proffapt's Telegram proffapt's LinkedIn proffapt's mail proffapt's forum for cybernity

(back to top)

Acknowledgments

(back to top)

Miscelleneous

Do consider looking at other paradigms of this documentation

(back to top)