/meditation

Flexible timer for meditation, working sessions & pomodoros.

Primary LanguageShell

meditation.sh

Flexible timer for meditation, working sessions & pomodoros.

Installation

git clone https://github.com/bcardoso/meditation "$HOME/bin/meditation"
chmod +x "$HOME/bin/meditation/meditation.sh"

# alias suggestion
echo "alias m='$HOME/bin/meditation/meditation.sh'" >> "$HOME/.bash_aliases"

# you might want to include the options you use the most
echo "alias m='$HOME/bin/meditation/meditation.sh -l'" >> "$HOME/.bashrc"
echo "alias p='$HOME/bin/meditation/meditation.sh -lpn'" >> "$HOME/.bashrc"

If you want to clone this repo to another location, remember to edit the BASEDIR variable in the meditation.sh file accordingly. Default time intervals and labels can also be set there.

Usage

USAGE:

    meditation.sh [OPTIONS] [<intervals>]

OPTIONS:

    -h    help
    -b    "/path/to/bell-sound.mp3"
    -c    countdown timer mode
    -C    write countdown state to file (-c is implied)
    -l    show interval labels
    -n    send notification on interval changes
    -p    pomodoro technique
    -q    quiet, no bell sound on interval changes
    -r    repeat forever (same as 'X/Y')
    -s    use a predefined interval sequence


EXAMPLES:

  meditation.sh             default interval is 25 minutes
  meditation.sh 2 3 5       set timer to 2, 3 and 5 minutes
  meditation.sh 23/5        loop for 23 and 5 minutes (same as '-r 23 5')
  meditation.sh -nl 23/5    same, with interval labels and notifications
  meditation.sh -p          start a pomodoro session
  meditation.sh -s          predefined interval sequence ('23 5 23 5 23')