https://github.com/qvl/sleepto
An alternative to traditional task schedulers
https://github.com/qvl/sleepto
cron golang job-scheduler schedule sleep-timer systemd task-scheduler
Last synced: about 1 month ago
JSON representation
An alternative to traditional task schedulers
- Host: GitHub
- URL: https://github.com/qvl/sleepto
- Owner: qvl
- License: mit
- Archived: true
- Created: 2016-11-29T16:24:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-06T15:18:29.000Z (over 7 years ago)
- Last Synced: 2025-01-22T00:43:11.058Z (5 months ago)
- Topics: cron, golang, job-scheduler, schedule, sleep-timer, systemd, task-scheduler
- Language: Go
- Homepage: https://qvl.io/sleepto
- Size: 44.9 KB
- Stars: 96
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# :zzz: sleepto
[](https://godoc.org/qvl.io/sleepto)
[](https://travis-ci.org/qvl/sleepto)
[](https://goreportcard.com/report/qvl.io/sleepto)
`sleepto` is a simple alternative to task schedulers like [Cron](https://en.wikipedia.org/wiki/Cron).
It only handles the timing and doesn't run a daemon like other schedulers do.
Instead we encourage you to use your systems default init system (for example [Systemd](#systemd)) to control your jobs.
This allows you to:
- Use and watch scheduled jobs the way you use all other services running on your system (for example using `ps`).
- Start and pause jobs like any other service on your system.
- Use your systems default logging system.
- No conflicts - next task is only scheduled after previous one finished.
- Trigger immediate execution by sending a `SIGALRM` signal.
- Specify execution times with the precision of seconds (Cron only supports minutes).
- Always know the time of the next execution.
Thanks to [runwhen](http://code.dogmap.org/runwhen/) for inspiration.
Usage: sleepto [flags...] [command...]
Sleep until next time the specified conditions match.
Conditions are specified with flags.
All flags are optional and can be used in any combination.
The condition flags take one or more value each.
Values are separated by comma.
Note that conditions match not the current, but the next possible match.
When the current date is March 2017
and you run 'sleepto -month 3' the execution time is March 1, 2018.
A command can be specified optionally.
All arguments following the command are passed to it.
When the process receives a SIGALRM signal it finishes immediately.
Examples:
# Next 10th of month at 3pm
sleepto -day 10 -hour 15 /bin/send-report
# Next occurence of one quarter of hour
sleepto -minute 0,15,30,45 say "Hello human"
# Next day at 1am
sleepto -hour 1 && ~/dbbackup.sh
Flags:
-day value
1 to 31
-hour value
0 to 23
-minute value
0 to 59
-month value
1 to 12
-second value
0 to 59
-silent
Suppress all output
-version
Print binary version
-weekday value
mo,tu,we,th,fr,sa,su
-year value
list of years
For more visit: https://qvl.io/sleepto
## Install
- With [Go](https://golang.org/):
```
go get qvl.io/sleepto
```
- With [Homebrew](http://brew.sh/):
```
brew install qvl/tap/sleepto
```
- Download from https://github.com/qvl/sleepto/releases
## Setup
`sleepto` can be used in different scenarios but the most common one is probably to combine it with an init system.
### [Systemd](https://en.wikipedia.org/wiki/Systemd)
[Systemd](https://en.wikipedia.org/wiki/Systemd) already runs on most Linux systems.
It even has its own [timer implementation](https://www.freedesktop.org/software/systemd/man/systemd.timer.html) which can be the right solution for many use cases.
However, if you don't want to depend on the specific features of one init system or you like to reuse the same logic in other scenarios `sleepto` can be the the right tool for that.
See [ghbackup for an example](https://github.com/qvl/ghbackup#systemd-and-sleepto) on how to use `sleepto` in a service.
- See the logs for your service use:
```
sudo journalctl -u servicename
```
- List processes which should include your service:
```
ps fux
```
- Immediately finish sleeping:
```
sudo systemctl kill -s ALRM servicename
```
## Development
Make sure to use `gofmt` and create a [Pull Request](https://github.com/qvl/sleepto/pulls).
### Releasing
Push a new Git tag and [GoReleaser](https://github.com/goreleaser/releaser) will automatically create a release.
## License
[MIT](./license)