Project

termodoro

0.01
No commit activity in last 3 years
No release in over 3 years
termodorovcavallo/termodoroHomepageDocumentationSource CodeBug TrackerWiki
Use this little utility to set simple reminders from the command line. See the github page below for more information
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
28,891
Stars
3
Forks
4
Watchers
0
 Releases
Current version
0.3.12
Total releases
11
First release
2013-10-22
Latest release
2013-10-31
 Issues
Open Issues
2
Closed Issues
0
Total Issues
2
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
3
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2013-12-24
Reverse Dependencies
0

 Dependencies

Development

json
>= 0
rspec
>= 0
simplecov
>= 0

Runtime

rake
>= 0
terminal-notifier
>= 0
 Project Readme

Termodoro

Gem Version
Build Status

RDoc Documentation

What is this?

Termodoro is an ultra-simple, frictionless BASH reminder / pomodoro timer ( in fact it's portmanteau of terminal and pomodoro )
You pass it an amount of time and a message. After the specified amount of time elapses the message pops up. Simple!

Why would I use this?

Maybe you're hard at work coding and you realize that there's something you need to do in 10 minutes… Rather than try to remember on your own or risk derailing your excellent programming groove by firing up a bulky reminder app, just enter a simple command into your terminal (where you're probably staring anyway). Hit enter and quickly get back to what you were doing!

Perhaps you're pair-programming and you want to switch roles in a given amount of time… Throw a quick command in between cds and lss and be on your way. Zero distractions.

You're already busy. Don't also be forgetful.
Too often I avoid setting a simple reminder because I don't want to interrupt my current flow - that shouldn't be a thing, and now it doesn't have to be.

Useage

Install:

gem install termodoro

Use:

termodoro 40 minutes switch pairs
termodoro 5m make a commit
termodoro 1 hr remember to eat
termodoro 10 seconds test termodoro

..etc...

A gentle warning…

This is the first gem I've built. I do not claim that it is perfect, nor that it follows best practices, nor that it is perfectly secure. Use at your own risk and feel free to fork this repo and improve any flaws you encounter. I'm wide open to suggestions for features as well.

Things I need to do:

  • The biggest one:
  • After that:
    • Object-Orient (shame on me.) / Actually think about design.
    • Instead of getting input from gets, the duration and message should be able to be passed in as flags/options (I need to figure out the difference.)
    • set defaults to something agreeable (like maybe 20 minutes and some generic 'do that thing you wanted to do' message) such that you could just do termodoro and it'll do that default.
    • Make it useable in other shells and without the terminal-notifier gem.
    • Sanitize the message so as to not cause bash issues
    • Write good tests!
    • Make sure to follow gem best-practices
    • Make sure it persists through computer sleep
    • Make sure I'm using ARGV properly and issuing the system command properly

Upcoming features:

  • set your own global defaults and shortcuts
  • option to set a reminder to repeat
  • option to pause/resume

Contributing:

You know the drill, right?

  • Fork.
  • Topic branches make puppies smile.
  • Make your feature addition or bug fix and be sure to include tests.
  • Update the CHANGELOG.md.
  • Send a pull request.