The break time reminder app
Stretchly is a cross-platform Electron app that reminds you to take breaks when working on your computer.
- Install
- Default behavior
- Preferences
- Advanced Preferences
- Contributor Preferences
- Development
- Known issues
- Contributors
- Humans and Tools
- License
The latest official installers and portable versions for macOS, Windows, Linux and FreeBSD can be found at Github Releases page.
You can also install Stretchly with Homebrew by running brew update && brew cask install stretchly. When upgrading, run brew update && brew upgrade --cask. Don't forget to Quit Stretchly, first.
Stretchly is not signed (due to its costs) so you will need to use this workaround for the first run: Open a Mac app from an unidentified developer.
You can also install Stretchly with Chocolatey by running the following command from the command line or from PowerShell: choco install stretchly. Upgrade with choco upgrade stretchly.
Stretchly is also available in Microsoft's winget.
You can install Stretchly for all users silently by running this as administrator: installer.exe /S /allusers.
For portable versions and for Linux/BSD installers, head to Github Releases page. The most widely used distributions should be covered.
Please see http://electron.atom.io/docs/api/tray/ for Electron's Tray Linux specifics. Having libappindicator1 installed should be enough for Stretchly.
For Natural breaks, you might need some packages too (libxss-dev).
If Stretchly is not starting, you might need to run sudo sysctl kernel.unprivileged_userns_clone=1. Read more here. Depending on your distro, you probably want to do something similar to this, so the settings are kept after reboot: Add kernel.unprivileged_userns_clone=1 to /etc/sysctl.d/00-local-userns.conf and reboot.
To run Stretchly from source you will need Node.js, ideally the one specified in package.json. Clone the repo, run npm install and then simply run npm start to start Stretchly.
You can create a custom installer by running npm run pack or npm run dist after npm install --no-save.
When you run Stretchly for the first time, you are presented with a Welcome window that allows you to change the language, review the settings, view the online tutorial or simply continue with the default settings.
Stretchly itself lives in your tray, only displaying a reminder window from time to time, which contains an idea for a break.
By default, there is a 20 second Mini Break every 10 minutes and a 5 minute Long Break every 30 minutes (after 2 Mini Breaks).
You'll be notified 10 seconds before a Mini Break (and 30 seconds before a Long Break) so that you can prepare to pause your work.
When a break starts, you can postpone it once for 2 minutes (Mini Breaks) or 5 minutes (Long Breaks). Then, after a specific time interval passes, you can skip the break. Both actions are available by clicking on the link at the bottom of window or by using the Ctrl/Cmd + X keyboard shortcut.
Clicking the Stretchly icon in your tray area will display the current status of breaks, provide menu items with extra functionality, and link to the Preferences.
Stretchly is monitoring your idle time, so when you are idle for 5 minutes, breaks will be paused until you return.
Stretchly is also monitoring Do Not Disturb mode, so breaks are paused when DnD mode is On.
Stretchly follows the theme of your system and is also available in dark mode.
When a Stretchly instance is running, the stretchly command can be use to interact with it from the command line.
Type stretchly help to get a list of all commands and options available as well as some examples.
Most of the preferences can be customized by clicking on the "Preferences" item in the tray menu.
Preferences are divided into multiple categories and you are encouraged to take some time to make Stretchly your own by customizing them.
You can also Restore the defaults to return to the default preferences state.
All preferences are saved in a JSON file. Use the Ctrl/Cmd + D shortcut while viewing the About section of Preferences, to show debug info and display a clickable link to the file.
It's recommended to Quit Stretchly before editing the preferences file.
To make sure that all works as expected, it's always good idea to check that format of the preferences file is correct, ie. by using jsonformatter.
Some of the extra settings are available in Contributor Preferences for Contributors. Those are marked by 
Note: Before 1.0, Mini Breaks and Long Breaks were called Microbreaks and Breaks, respectively. To keep the upgrade smooth they still use that name in preferences file and in code.
In the preferences file, change useIdeasFromSettings: false, to useIdeasFromSettings: true, and edit breakIdeas and microbreakIdeas.
Note that when a new Stretchly version with new break ideas is out, your custom ideas will not be overwritten.
In the preferences file, change breakNotificationInterval: 30000, to whatever value you want. 30000 is 30 seconds. Same goes for Mini Breaks.
In the preferences file you can set the morningHour setting to pause until that hour today or the next day
Otherwise, you can set morningHour: "sunrise" and set posLatitude, posLongitude in
settings to pause until the actual sunrise in your area.
E.g. if you live in Boston you would set:
morningHour: "sunrise",
posLatitude: 42.3,
posLongitude: 71
In the preferences file, you can edit microbreakPostpone and breakPostpone to enable or disable the ability to postpone breaks, microbreakPostponeTime and breakPostponeTime to change the postpone time in milliseconds, microbreakPostponesLimit and breakPostponesLimit to change the number of allowed postpones per break, and finally, microbreakPostponableDurationPercent and breakPostponableDurationPercent to change the percentage of the break during which the user can postpone it.
In the preferences file, set notifyNewVersion: false, to disable new version notification.
In the preferences file, set microbreakStartSoundPlaying: true, to start a Mini Break with a sound (The same sound will be played as at the end of the break). Same for breakStartSoundPlaying.
In the preferences file, set naturalBreaksInactivityResetTime to your preferred value (in milliseconds greater than than 20000ms). This is an idle time length, after which Stretchly breaks will be paused until the user resumes activity.
In the preferences file, set volume to your preferred value. Default value is 1, which is 100% volume. Set it, for example, to 0.61 for 61% volume.
In the preferences file, set endBreakShortcut to your preferred value. We do not validate this input, so please check Electron's documentation for available values for key and modifier.
In the preferences file, change themeSource: 'system' to either 'light' or 'dark' to always use the specified theme.
To show the Welcome window again on the next start, change "isFirstRun" to true.
To specify how solid the break window should be when Theme transparency is enabled, set the value of opacity from 0 to 1 (which is in turn 0 to 100%).
To specify the size of the break window, set the value of breakWindowHeight and breakWindowWidth from 0 to 0.99 (which is in turn 0 to 99% of the size of the screen). Don't set 100% as that's fullscreen.
If you don't want to ever check for new version, set checkNewVersion to false.
Stretchly is free but you can support it by contributing code, translations or money. You will be rewarded by getting access to Contributor Preferences, ability to Sync Preferences, chat on Discord and more!
You can access contributor features after authenticating with Github or Patreon in the "Love Stretchly" section of Preferences.
GitHub Sponsors does not charge any fees for sponsorships from user accounts, so 100% of these sponsorships go to the sponsored developer or organization. Github Sponsors Matching Fund will also match every donation.
You will be able to access Contributor Preferences, Sync Preferences. You won't be able to chat on Discord.
Patreon has fees plus it uses PayPal, which has its fees as well.
You will be able to access Contributor Preferences, Sync Preferences and Discord chat.
PayPal has fees.
Currently, there are no rewards for donating via PayPal, as we can't programmatically match them.
By contributing code (or translations), you will be able to access Contributor Preferences, Sync Preferences. You won't be able to chat on Discord.
Feel free to join in the development of this app via Issues and Pull Requests.
Before implementing a feature, please open an Issue first, so we can be sure that no one else is working on it and that the changes will be accepted. It is important do discuss changes before implementing them (Why should we add it? How should it work? How should it look? Where will it be? ...).
- Node.js (please use version specified in
package.json)- Linux/MacOS - you might want to use Node Version Manager to install specific version
- Windows - download installer for specific version; during installation check “Install Additional Tools for Node.js”
- git
- Github account, if you'd like to upstream your changes
Now you can clone the repo with git clone https://github.com/hovancik/stretchly.git. Change to the new created directory and run npm i to install node packages needed.
Read on.
If you start Stretchly in development mode with the npm run dev command, it makes it possible to debug the application in your browser on http://localhost:9222.
Also, you can use Stretchly's built-in debug shortcut by pressing Ctrl/Cmd + D in the About section to show information such as:
- Location of the preferences and log file (Clicking on file location will open it.)
- Debug information for break planner
You can copy debug information to the clipboard.
Stretchly uses log package for some extra logging.
Format as following:
System: my messagefor messages regarding Operating System, ie:System: resume or unlockStretchly: my messagefor messages regarding Stretchly
- users who upgraded to Windows 10 from previous Windows versions might be in "Do Not Disturb mode" all the time so they need to check "Show breaks even in Do Not Disturb mode"
- tray tooltip does not work correctly on macOS (electron/electron#9447)
- tray tooltip does not work correctly on Linux (electron/electron#15161)
- fullscreen is not shown on all displays on Windows (electron/electron#16907)
- power monitoring not working properly (electron/electron#8560)
- tray icon is not always rendered correctly on Linux (electron/electron#12791)
- Jan Hovancik, @hovancik, hovancik.net
- Martina Mocinecova, (pre-1.0 Stretchly logo), color schemes
- Jason Barry, @JCBarry, jcbarry.com
- Alex Alekseyenko, @alexalekseyenko
- Sean Manton, @sxmanton
- Yuriy Gromchenko, @gromchen
- Mael, @laem
- Marian Dolinský, @bramborman
- midpoint, @midpoint
- stothew, @stothew
- Zhivko Kabaivanov, @unholyHub
- sergiopjf, @sergiopjf
- William Chang, @wilicw
- Purva, @purva98
- Riddhi, @riddhi99
- Fahim Dalvi, @fdalvi, fdalvi.github.io
- Nic Desjardins, @nicdesjardins
- Vladislav Kuznecov, @fizvlad
- Oleg V., @neooleg
- Manuel Jesús Aguilera Castro, @manueljaguilera
- Ciprian Rusen, www.digitalcitizen.life
- Carlo Gandolfi, @cgand
- Kavya Jain, @kavya-jain
- Denys Otrishko, @lundibundi
- p-bo, @p-bo
- Alina Leuca, @alinaleuca
- Sabine van der Eijk, @Sabin_E
- JavaScript Joe, @jsjoeio
- Ismail Demirbilek, @dbtek
- Giacomo Rossetto, @jackymancs4
- Hum4n01d, @hum4n01d
- Ary Borenszweig, @asterite
- Jonatan Nyberg, @jony0008
- Gowee @Gowee
- William Lin, @FanciestW
- Hisman Yosika, @dnjstlr555
- Mehmet Fatih Yıldız, @mfyz
- Sunny Dhoke, @sunn-e
- Przemysław Rząd, @rzadp
- Artūras Stifanovičius, @troyanas
- pan93412, @pan93412
- robot-5, robot-5
- mfyz, mfyz
- ValarMarkhulis ValarMarkhulis
- Lucas Costi, @lucascosti
- Luke Arms, lkrms
- Chris Heyer, @cheyer
- Sheri Richardson, @sheriallis
- Felix W. Dekker, @FWDekker
- Balazs Nasz, @balazsnasz
- Daniel Bankmann, @dbankmann
- Aziks, @Aziks0
- mwoz123, @mwoz123
- pramit-marattha, @pramit-marattha
- Benedikt Allendorf, @BenediktAllendorf
- Haechan Song, @hcsong213
Also see Github's list of contributors.
1.0 Icon and UI design by Colin Shanley (www.colinshanley.com).
- https://www.icoconverter.com/ to generate .ico
- http://www.img2icnsapp.com/ to create .icns
- https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/
- http://web.stanford.edu/dept/EHS/prod/general/ergo/microbreaks.html
- https://www.spineuniverse.com/wellness/ergonomics/workstation-ergonomics-take-break
- http://www.lifehack.org/articles/productivity/21-counter-intuitive-break-ideas-to-boost-your-productivity-at-work.html
- http://www.latofonts.com/lato-free-fonts/
- http://www.huffingtonpost.com/2012/07/24/sitting-at-work-why-its-dangerous-alternatives_n_1695618.html
- http://www.unm.edu/~lkravitz/Article%20folder/sittingUNM.html
- https://www.ninds.nih.gov/News-Events/News-and-Press-Releases/Press-Releases/Want-learn-new-skill-Take-some-short-breaks
- https://www.painscience.com/articles/chair-trouble.php
- https://www.painscience.com/articles/microbreaking.php
- https://github.com/CognirelTech/Quillpad-Server
- https://www.webmd.com/fitness-exercise/a-z/seven-minute-workout
- https://www.poetryfoundation.org/poems/57243/how-to-be-perfect
- https://justworks.com/blog/improve-mental-health-work-midday-break-ideas
- https://www.nutritiousmovement.com/dynamic-at-home-work-and-school-spaces/
- https://www.onhealth.com/content/1/eye_exercises_and_stretches
- https://www.webmd.com/pain-management/exercises-carpal-tunnel-syndrome
Sounds used in this application are listed here.
crystal glassby mlteenie, available under the Attribution License.wind chimeby GnoteSoundz, available under the Creative Commons 0 License.tic tocby magundah14, available under the Creative Commons 0 License.silenceby parcodeisuoni, available under the Attribution License.
This app uses Open Sans fonts licensed under the Apache License, Version 2.0.
See LICENSE file.