Skip to content

README.md

Latest commit

聽

History

History
129 lines (94 loc) 路 2.93 KB

README.md

File metadata and controls

129 lines (94 loc) 路 2.93 KB
Raw

Pomodoro Terminal Timer 馃崊

Pomodoro Timer Screenshot

A simple terminal-based Pomodoro timer written in Bash, using a clean timer and audio alert via aplay or afplay.

This script supports work and break sessions with customizable durations and colorful output, designed for Windows (via WSL2), Linux and Mac users.

Acknowledgements

I would like to mention this project was inspired by the work of bashbunni.

Her script provided the foundation, which was tweaked to add the audio file and custom durations.

Custom Sounds

You can use your own .wav file for the alert sound:

  • Replace alert.wav with your own file.
  • Move it to ~/.local/bin/ (or wherever your script is)
  • Edit the SOUND_FILE path in pomodoro.sh
SOUND_FILE="$SCRIPT_DIR/your-custom-sound.wav"

Features

  • Work sessions (default: 45 minutes)
  • Break sessions (default: 10 minutes)
  • Audio alert using alert.wav (included)
  • Colorful output with lolcat (optional)
  • Compatible with Windows (WSL2) and Linux

馃敡 Requirements

  • Bash or Zsh (bash comes pre-installed on Linux and WSL2)
  • timer by caarlos0
  • aplay or afplay (via alsa-utils for playing the alert sound)
  • lolcat for colorful output (optional)
  • A terminal with zsh or bash for alias setup

Installation

(WSL2/Linux)

Install Dependencies:

Update your package manager and install alsa-utils and lolcat(optional):

sudo apt update
sudo apt install alsa-utils lolcat

Install timer caarlos0

(Mac)

Install Dependencies:

Install Homebrew

Install timer & lolcat

brew install caarlos0/tap/timer
brew install lolcat

Clone the Repository:

git clone https://github.com/rosscondie/cli-pomodoro-timer.git
cd cli-pomodoro-timer

Make the Script Executable:

chmod +x pomodoro.sh

Move the Script to a local bin directory:

This allows you to run pomodoro.sh from anywhere if it's in ~/.local/bin

To make sure your shell recognizes it add this to your shell config file ~/.bashrc or ~/.zshrc if it is not already present:

export PATH="$HOME/.local/bin:$PATH"

Copy the script and sound file to ~/.local/bin (create the directory if it doesn't exist):

mkdir -p ~/.local/bin 
cp pomodoro.sh alert.wav ~/.local/bin/

Set Up Aliases: Add the following to your ~/.zshrc or ~/.bashrc:

source ~/.local/bin/pomodoro.sh
alias wo="pomodoro work"
alias br="pomodoro break"

Reload your shell config:

source ~/.zshrc 
# or source ~/.bashrc

Usage

Start a work session (45 minutes by default):

wo

Start a break session (10 minutes by default):

br

Specify a custom duration (e.g. 25m work session or 5m break session):

wo 25

# for the break session
br 5