/cron-utils-cli

CLI utilities for cron-utils core.

Primary LanguageJavaApache License 2.0Apache-2.0

cron-utils-cli

Command line interface to cron-utils, a Java library to parse, validate, migrate crons as well as get human readable descriptions for them. The project follows the Semantic Versioning Convention

Gitter Chat Build Status Coverage Status

Codacy Badge Project stats by OpenHub

Download

cron-utils-cli is available on Maven central repository.

<dependency>
    <groupId>com.cronutils</groupId>
    <artifactId>cron-utils-cli</artifactId>
    <version>7.0.1</version>
</dependency>

cron-utils CLI

We provide a simple CLI interface to use cron-utils right from console, without writing a new project! cron-utils-cli uses semantic versioning, but since lifecycle does not match the one of the core library, references the tag commit hash in core as metadata in satellite libraries release versions as means to keep traceability to the core library.

  • Usage: java -jar cron-utils-cli.jar com.cronutils.cli.CronUtilsCLI --validate -f [CRON4J|QUARTZ|UNIX|SPRING] -e '<cron expression>'

  • Example: java -jar cron-utils-cli.jar com.cronutils.cli.CronUtilsCLI --validate -f UNIX -e '* 1 * * *'

  • Print Description: java -jar cron-utils-cli.jar com.cronutils.cli.CronUtilsCLI --describe --language en -f UNIX -e '* 1 * * *'

If you want a standalone jar without requiring the 'cp', build an uber jar with :

mvn assembly:assembly -DdescriptorId=jar-with-dependencies

Then, launch cli-utils (built in the target directory) with :

java -jar cron-utils-cli-<version>-jar-with-dependencies.jar com.cronutils.cli.CronUtilsCLI --validate -f [CRON4J|QUARTZ|UNIX] -e '<cron expression>'`

Contribute & Support!

Contributions are welcome! You can contribute by

  • starring and/or Flattring this repo!
  • requesting or adding new features. Check our roadmap!
  • enhancing existing code: ex.: provide more accurate description cases
  • testing
  • enhancing documentation
  • providing translations to support new locales
  • bringing suggestions and reporting bugs
  • spreading the word
  • telling us how you use it! We look forward to list you at our wiki!

Check our page! For stats about the project, you can visit our OpenHUB profile.

Support us donating once or by subscription through Flattr!

Flattr this!

Other cron-utils projects

You are welcome to visit and use the following cron-utils projects:

  • cron-utils: cron-utils core library. Provides means to parse, validate, migrate crons as well as get human readable descriptions for them.
  • htime: A Java library to make it easy for humans format a date. You no longer need to remember date time formatting chars: just write an example, and you will get the appropiate formatter.
  • cron-utils-spring: A Java library to describe cron expressions in human readable language at Spring framework, using cron-utils.
  • cron-utils-cli: cron-utils features made available through a CLI.
  • cron-utils-sisyphus: A Scala scheduler that supports multiple cron notations.
  • cron-utils-scheduler: A Java job scheduler based on cron-utils library.