Awesome

⏰ Tim (Timer Script)

Screenshot

🚨 Description

Terminal countdown timer with several modes written in Zsh shell script. Currently Tim got a countdown timer, interval timer, pomodoro timer and magical powers.

🚀 Usage

It's really easy to play with Tim. Just run the script!

./tim --help

📦 Installation

All you need to do is move the file tim to a directory in your shell PATH and move the directory audio_files to ~/.tim (this is only needed if you want to use the default alarm commands and files). If you want to specify your own commands then you can just move timrc.example to ~/.timrc and edit the settings.

⚙️ Configuration

Read comments in file timrc.example for more information.

🐚 Dependencies

You need to have Zsh installed to run this.

When using default settings Tim depends on:

macOS:
- afplay - Comes with macOS.
Linux:
- aplay - Comes with alsa-utils.

🦄 Tips

If you use macOS you can put this in ~/.timrc to make it speak:

work_cmd="say start working now"
break_cmd="say take a little break"
pomodoro_cmd="say working session is over. take a break"

If you use Tim on multiple platforms you could use something like:

if [[ $OSTYPE == darwin* ]]; then
    # macOS settings here
else
    # Everything else here
fi

If you are sick of life you could try out this:

timer_cmd="sudo rm -rf /"

Or if you need to celebrate after a pomodoro session:

pomodoro_cmd="open rick-roll.avi"    # macOS
pomodoro_cmd="mplayer rick-roll.avi" # Linux

⚠️ Quirks

Writing a tool like this in Zsh is completely insane. It makes no sense at all. But here we are and this, my own Frankenstein's monster, is a beautiful beast.

📜 License

Released under the BSD 3-Clause License.

Copyright (c) 2022, Göran Gustafsson. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.