Stretchly
The break time reminder app
Install / Use
/learn @hovancik/StretchlyREADME
Stretchly 
<img src="stretchly_128x128.png" align="right" alt="Stretchly logo">
The break time reminder app
Stretchly is a cross-platform Electron app that reminds you to take breaks when working on your computer.
Table of contents
- Install
- Default behavior
- Preferences
- Advanced Preferences
- Contributor Preferences
- Development
- Known issues
- Contributors
- Humans and Tools
- License
Install 
The latest official installers and portable versions for macOS, Windows and Linux can be found at Github Releases page. For supported versions of your OS check Electron's supported versions. Read on for details of specific OSes.
macOS
It is recommended to install Stretchly with Homebrew tap by running the following command. See Application Signing for details.
brew install --cask --no-quarantine hovancik/stretchly/stretchly
When upgrading, run the following command. Don't forget to Quit Stretchly, first.
brew upgrade --cask hovancik/stretchly/stretchly
If you're using Alfred or Raycast on macOS you can use this Alfred Workflow or Raycast Extension to interact with Stretchly.
Application Signing
Stretchly is not signed (due to its costs and me not owning supported Apple device) so you will need to use a workaround for the first run. The workaround depends on if you're running an Intel or Apple Silicon chip.
- Intel Chips: Open a Mac app from an unidentified developer.
- Apple Chips: Open a terminal and run this command:
sudo xattr -r -d com.apple.quarantine /Applications/Stretchly.app
If you install via Homebrew, you can use the --no-quarantine flag to automatically apply the correct
workaround.
brew install --cask --no-quarantine hovancik/stretchly/stretchly
Not sure which chip your computer has? Here's how to tell.
Windows
You can also install Stretchly with Chocolatey by running the following command from the command line or from PowerShell:
choco install stretchly
To update:
choco upgrade stretchly
Stretchly is also available in Microsoft's winget. You can install it by running:
winget install -e --id Stretchly.Stretchly
Stretchly can be also found at official Microsoft Store.
You can install Stretchly for all users silently by running this as administrator:
installer.exe /S /allusers
Linux / Portable
For portable versions and for Linux installers, head to Github Releases page. The most widely used distributions should be covered.
Stretchly is also available in some of the Linux stores:
For Debian/Ubuntu and derivates you could also try this apt repository: deb [trusted=yes] https://apt.fury.io/hovancik/ /.
Linux note
Please see http://electron.atom.io/docs/api/tray/ for Electron's Tray Linux specifics.
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
sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
Read more here. Depending on your distro, you probably want to do something similar to this, so the preferences are kept after reboot: Add kernel.unprivileged_userns_clone=1 and kernel.apparmor_restrict_unprivileged_userns=0 to /etc/sysctl.d/00-local-userns.conf and reboot.
If you're on Wayland and you would like to be able to monitor idle time, you'll need to add your user to input group, with sudo gpasswd --add $USER input (depending on your distro) and logout/login to take an effect.
Running from source
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.
Custom installer
You can create a custom installer by running npm run pack or npm run dist after npm install --no-save.
Default behavior
When you run Stretchly for the first time, you are presented with a Welcome window that allows you to change the language, review the preferences, view the online tutorial or simply continue with the default preferences.
<img src="welcome.png" height="340">Stretchly itself lives in your tray, only displaying a reminder window from time to time, which contains an idea for a break.
<img src="minibreak.png" height="340">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).
<img src="longbreak.png" height="340">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.
<img src="notification.png" height="90">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.
<img src="tray.png" height="140">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.
<img src="dark.png" height="340">Interact with stretchly from command line
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.
Preferences
Most of the preferences can be customized by clicking on the "Preferences" item in the tray menu. (On Windows, to open Preferences, you can also double-click on the tray icon.)
<img src="preferences.png" height="340">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.
Advanced Preferences
While the most of the preferences can be edited via the app, some options and values are not available to make the app easy to understand and setup.
All preferences are saved in a JSON file, so you can set Stretchly in the way you need. Use the Ctrl/Cmd + D shortcut while viewing the About section of Preferences, to show debug info and display a clickable link to the preferences 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.
After you make changes to preferences files, some of the values being shown in Preferences or elsewhere might show incorrect value, as the UI is expecting specific values and is not handling cases where user makes manual changes to preferences file.
Some of the extra preferences are available in Contributor Preferences for Contributors. Those are marked by 
