https://github.com/drgrib/ttimer
Terminal countdown timer, written in Go
https://github.com/drgrib/ttimer
go golang minutes timer
Last synced: 10 months ago
JSON representation
Terminal countdown timer, written in Go
- Host: GitHub
- URL: https://github.com/drgrib/ttimer
- Owner: drgrib
- License: mit
- Created: 2017-03-18T03:30:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-01-23T18:13:59.000Z (over 2 years ago)
- Last Synced: 2025-04-02T01:34:37.562Z (about 1 year ago)
- Topics: go, golang, minutes, timer
- Language: Go
- Homepage:
- Size: 229 KB
- Stars: 78
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ttimer - Terminal Timer
`ttimer` is a simple timer that counts down time left in a terminal window. If run on Mac, Windows, or desktop Linux, it will send silent system notifications at 90% and 100% completion.
## Installing
### macOS
```
brew install drgrib/tap/ttimer
```
#### Upgrading
To get the latest version after installing with `brew`, use:
```
brew upgrade ttimer
```
### go install
```
go install github.com/drgrib/ttimer@latest
```
To make it accessible on the command line as `ttimer`, ensure you've added `$GOPATH/bin` to your `$PATH`.
## Duration Timing
Lets say you want a timer for 3 minutes. Simply enter:
```
ttimer 3
```
This will start a timer count down like so:
```
== 3m Timer ==
2m55s
```
Or if you want a very specific duration, you can specify it using:
```
ttimer 3h2m5s
```
Or if you want a very short time:
```
ttimer 30s
```
## End Time Timing
Let's say you need to leave for the bus by *8:12 am*, which is coming up in the next hour. You could simply enter:
```
ttimer 812
```
And `ttimer` will automatically infer the next occurrence of `8:12`, which is `am`:
```
== 812a Timer ==
23m29s
```
If you want to force it to set a timer for *8:12 __pm__*, you could use:
```
ttimer 812p
```
Resulting in something like:
```
== 812p Timer ==
12h22m25s
```
If you want a timer for *3:00 pm*, you could simply enter:
```
ttimer 3p
```
All end time timers are set to align to zero seconds on the minute so they will change over to new minutes with the system clock.
## Parsing Rules
* Integers less than `100` and floats will be interpreted as minutes.
* Strings fitting a call to [`time.ParseDuration`](https://golang.org/pkg/time/#ParseDuration) will be interpreted as that duration. E.g. `1m30s` or `2h`.
* Strings ending in `a`, `p`, `am`, or `pm` will be interpreted as times. E.g. `1p` or `930a`.
* Integers greater than or equal to `100` will be interpreted as times. E.g. `242` will be interpreted as the next occurrence of `2:42` and set to `am` or `pm`, whichever is soonest.
## Exiting
To exit the timer at any time, simply press `q`.
## Auto Exit
To make the timer automatically exit after finishing, pass the `-q` argument like this
```
ttimer -q 30s
```