Python command line tool for MacOS and Linux to remind you to take breaks when working. Set a reminder interval and an optional custom message from the command line and don't worry about it until the reminder! At each reminder you can also optionally input a productivity score (1-10) which will be saved in a local productivity.log file.
Note
Has only been fully tested on MacOS. It should work in theory on Linux as well but has not been tested.
Open the take-a-break folder after downloading and run the following command in the terminal: ./setup.sh
OR
git clone https://github.com/JasonEl1/take-a-break.git
cd take-a-break
./setup.sh
Use the tool using the name work in the terminal. The following commands are available:
work get -> get current state of work mode (set / unset)
work set -> set work mode with default interval of 20 minutes
work set -t value -> set work mode with specific reminder interval (minutes)
work set -t value -m message -> set work mode with custom reminder interval and message
work unset -> unset work mode
work next -> get time remaining until next reminder
work log -> get all productivity log entries
work message -> get current reminder message
work message -m message -> set reminder message to custom string
work message -m message -p preset -> set reminder message and save as preset
work message -rmp preset -> remove a saved message preset
work message -l -> list all saved message presets
work settings -> print current settings.json contents
work settings -e -> edit a settings parameter
work --help -> show help page
Tip
Use work message -m default to set reminder message back to default
Settings are stored in ~/.local/share/take-a-break/settings.json.
When work mode is enabled, you will be reminded to take a break from your work via a popup window at a certain time interval. You will also be prompted to (optionally) log how productive you think you were since the previous break.
The program will remind you to take a break after the specified time interval with the option to reset the reminder or unset work mode. The program does not continue running after work set is called, but makes use of cron to schedule the reminder at the correct time.
Use the command work uninstall and follow the prompts.