schedules · Sextant docs

Text

sextant schedules create   Create a schedule
sextant schedules list     List schedules
sextant schedules get      Show one schedule and its next runs
sextant schedules update   Change cron, timezone or payload
sextant schedules pause    Stop creating jobs
sextant schedules resume   Start creating jobs again
sextant schedules delete   Delete a schedule

schedules create

Shell

sextant schedules create nightly-report \
  --cron "0 2 * * *" --timezone Europe/Paris \
  --queue reports --handler build-report --payload '{"range":"24h"}' \
  --overlap skip

The first argument is the schedule’s unique name.

--cronstring optional

Five-field expression. Either --cron or --every is required.

--everyduration optional

Fixed interval such as 15m.

--timezonestring optional default UTC

IANA time zone for --cron.

--queuestring required

Queue for created jobs.

--handlerstring required

Handler name.

--payloadjson optional default {}

Payload for every job.

--overlapstring optional default skip

skip, queue or allow. See Scheduling jobs.

--catch-upboolean optional

Create a job for every missed tick, up to 100.

schedules get

Shows the next five planned runs in the schedule’s time zone, which is the quickest way to check an expression:

Shell

$ sextant schedules get nightly-report
nightly-report  0 2 * * * (Europe/Paris)  active  overlap=skip
next runs
  2026-10-21 02:00 CEST   (in 16h 44m)
  2026-10-22 02:00 CEST
  2026-10-23 02:00 CEST
  2026-10-24 02:00 CEST
  2026-10-25 02:00 CEST
last run   2026-10-20 02:00 CEST  job_41ac0e17  succeeded

schedules update, pause, resume, delete

Shell

sextant schedules update nightly-report --cron "30 2 * * *"
sextant schedules pause nightly-report
sextant schedules resume nightly-report
sextant schedules delete nightly-report --yes

Changing --cron or --timezone recomputes the next run immediately.