Product documentation
  • Overview
  • Guide
  • Reference
  • Changelog
Report a problem

Reference

Every option

Grouped by where it goes. Anything not listed here does not exist.

Job options

  • schedule

    A calendar expression with a time zone. Required. Examples: every day at 03:00 Europe/Madrid, every 15 minutes, every Monday at 09:30 UTC.

  • command

    The command to run. Required. Executed without a shell unless you ask for one.

  • timeout

    How long the job may take before it is killed and counted as failed. Defaults to one hour.

  • working_directory

    Where the command runs. Defaults to the directory Kettle was started in.

Notifiers

  • notify

    A list of notifier names. Each one is called once per failure, never per retry.

  • notify.command

    A command to run on failure, with the job name and exit code in the environment.

  • notify.email

    An address. Requires an outbound mail configuration in the same file.

Command line

  • --config

    Path to the schedule file. Defaults to kettle.toml in the working directory.

  • --once

    Run every job that is due now, then exit. Useful from another scheduler.

  • --check

    Parse the file, report what would run and when, and exit without running anything.

Something wrong?

Report a problem

Tell us the version, the schedule line and what happened instead.

Product documentation

Kettle: a small tool for scheduled jobs.

Docs

  • Guide
  • Reference

Legal

  • Legal notice
  • Privacy
All rights reserved.