Skip to content

ezgh workflows schedules create

Create a schedule that starts runs on a cron timetable.

Updated View as Markdown
ezgh workflows schedules create <name> --workflow w --cron c [--app a] [--time-zone tz] [--input json] … [flags]

Create a schedule: it starts runs of one workflow of one app (--app, by ID, slug or name; it may be left out when the project has one app) on a cron timetable read in --time-zone. Every run gets --input. --overlap says what a firing does while the schedule’s last run is still going: skip it (the default), allow another run, or bufferOne (start one run when the last ends). Creating a schedule also needs workflows.runs.start on the workflow. Names needn’t be unique, but a schedule is easier to name on the command line when its name is.

Part of ezgh workflows schedules.

Examples

ezgh workflows schedules create nightly-report --workflow report --cron "0 3 * * *" --time-zone Europe/London
ezgh workflows schedules create sync --app workers --workflow sync --cron @hourly --input '{"full": false}' --paused

Flags

Flag Type Default Description
--app string the app, by ID, slug or name (default: the project’s only app)
--catchup-window duration 1h0m0s how late a missed firing may still start (after an outage), up to 24h
--cron string when it fires: 5 fields (minute hour day-of-month month day-of-week), or @hourly, @daily, @weekly, @monthly, @yearly
--input string every run’s input: a JSON value, @file, or - for stdin
--jitter duration a random delay of up to this much for each firing, up to 1h
--overlap string skip when a firing finds its last run still going: skip, allow, or bufferOne
--paused boolean create it paused: it fires once resumed
--time-zone string UTC the IANA time zone the cron is read in
--workflow string the workflow the schedule starts

This command also takes the global flags.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close