CELERY-BEAT(1)

πŸ“¦
version 5.6.3 Β· 4 versions
, in ubuntu stonking

πŸ’– CELERY-BEAT(1) πŸ’–

okay so bestie, welcome to the celery beat manual page β€” this is your little guide to starting the beat periodic task scheduler ✨ (and yeah, that's the NAME section right there, folder in the manual name too: this is a page from the celery beat Manual, section 1 πŸŽ€)


✨ SYNOPSIS ✨

celery beat [OPTIONS]

that's it, that's the whole vibe. you call celery beat and you hand it some [OPTIONS]. slay πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

Start the beat periodic task scheduler. πŸŽ€

like... that's literally her job. she's the one who shows up on time, every time, and makes sure your periodic tasks actually happen. main character energy fr fr πŸ‘‘


🌸 OPTIONS 🌸

  • --detach β€” dip out and keep running in the background as a daemon. she's not clingy, she'll just live in the background doing her thing 🫢
  • -s, --schedule TEXT β€” the path to the schedule database. defaults to celerybeat-schedule. and psst β€” the extension '.db' may be appended to the filename πŸ‘€
  • -S, --scheduler TEXT β€” which scheduler class to use. pick your fave πŸŽ€
  • --max-interval INTEGER β€” the max number of seconds to sleep between schedule iterations. aka nap time cap 😴
  • -l, --loglevel [DEBUG|INFO|WARNING|ERROR|CRITICAL|FATAL] β€” logging level. choose your noise level, from DEBUG (everything, all of it, no filter) all the way up to FATAL πŸ’€
  • -f, --logfile TEXT β€” where the logs go. defaults to stderr πŸ“
  • --pidfile TEXT β€” the PID file path. defaults to no PID file (so like, she's unbothered, no tracking number πŸ¦‹)
  • --uid TEXT β€” drops privileges to this user ID πŸ”»
  • --gid TEXT β€” drops privileges to this group ID πŸ”»
  • --umask TEXT β€” create files and directories with this umask πŸ› οΈ
  • --executable TEXT β€” override the path to the Python executable 🐍

bestie reminder: every one of these is exactly what it says on the tin β€” don't get cute and invent extra flags, she has a very specific list and this is the whole list πŸ’œ

okay and that's the whole page!! it's giving short, it's giving sweet, it's giving "go schedule some periodic tasks, queen" βœ¨πŸ¦‹πŸŒΈ

signing off from the footer, where the source line lives: this is from the celery beat Manual, version 5.6.3, dated 2026-05-14 β€” periodt πŸ’…πŸ‘‘

πŸ“¦ where this page comes from