An alternative to traditional task schedulers
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
flags Support for -year flag. May 13, 2017
match Support for -year flag. May 13, 2017
.gitignore ignore dist dir Jan 5, 2017
.travis.yml Update to Go 1.9 Oct 3, 2017
goreleaser.yml Update to Go 1.9 Oct 3, 2017
license setup Jan 2, 2017
main.go Cleaning. Jun 13, 2017
main_test.go Support for -year flag. May 13, 2017
readme.md Fix a typo Dec 6, 2017

readme.md

💤 sleepto

GoDoc Build Status Go Report Card

sleepto is a simple alternative to task schedulers like 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) 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 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:
go get qvl.io/sleepto
brew install qvl/tap/sleepto

Setup

sleepto can be used in different scenarios but the most common one is probably to combine it with an init system.

Systemd

Systemd already runs on most Linux systems.

It even has its own timer implementation 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 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.

Releasing

Push a new Git tag and GoReleaser will automatically create a release.

License

MIT