Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moiaune/stretchreminder
A simple break/stretch reminder in Powershell.
https://github.com/moiaune/stretchreminder
break-reminder break-timer powershell powershell-core powershell-module stretch-reminder
Last synced: 28 days ago
JSON representation
A simple break/stretch reminder in Powershell.
- Host: GitHub
- URL: https://github.com/moiaune/stretchreminder
- Owner: moiaune
- License: gpl-3.0
- Created: 2020-12-27T15:56:23.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-07T06:29:33.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T21:01:31.432Z (28 days ago)
- Topics: break-reminder, break-timer, powershell, powershell-core, powershell-module, stretch-reminder
- Language: PowerShell
- Homepage:
- Size: 920 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StretchReminder
## TODO
- [ ] Use https://github.com/Windos/PoshNotify for non-windows systems
- [ ] Consider starting as background job instead of leaving terminal open
## Installation (on Windows)
This module requires the BurntToast module for displaying notifications on Windows. You can install it from the PowershellGallery.
```powershell
Install-Module -Name BurntToast -Scope CurrentUser
Install-Module -Name StretchReminder -Scope CurrentUser
```
## Installation (macOS / Linux)
Notifications are not supported for macOS/Linux at the moment (working on it), and therefor no point in installing it for these operating systems.
## How To Use
```powershell
# Will notify you every 15 minutes and count down from 15 seconds each time.
Start-StretchReminder
# Will notify you every 30 minutes and count down from 15 seconds each time.
Start-StretchReminder -Interval 30 -Duration 15
```
NOTE: Currently, the terminal must be left open when you run this module.