This document describes Celery 3.0. For development docs, go here.

celery.bin.celerybeat

The celery beat command.

See also

See Preload Options and Daemon Options.

--detach

Detach and run in the background as a daemon.

-s, --schedule

Path to the schedule database. Defaults to celerybeat-schedule. The extension ‘.db’ may be appended to the filename. Default is %(default)s.

-S, --scheduler

Scheduler class to use. Default is celery.beat.PersistentScheduler.

-interval

Max seconds to sleep between schedule iterations.

-f, --logfile

Path to log file. If no logfile is specified, stderr is used.

-l, --loglevel

Logging level, choose between DEBUG, INFO, WARNING, ERROR, CRITICAL, or FATAL.

class celery.bin.celerybeat.BeatCommand(app=None, get_app=None)

doc = "\n\nThe :program:`celery beat` command.\n\n.. program:: celery beat\n\n.. seealso::\n\n See :ref:`preload-options` and :ref:`daemon-options`.\n\n.. cmdoption:: --detach\n\n Detach and run in the background as a daemon.\n\n.. cmdoption:: -s, --schedule\n\n Path to the schedule database. Defaults to `celerybeat-schedule`.\n The extension '.db' may be appended to the filename.\n Default is %(default)s.\n\n.. cmdoption:: -S, --scheduler\n\n Scheduler class to use.\n Default is :class:`celery.beat.PersistentScheduler`.\n\n.. cmdoption:: max-interval\n\n Max seconds to sleep between schedule iterations.\n\n.. cmdoption:: -f, --logfile\n\n Path to log file. If no logfile is specified, `stderr` is used.\n\n.. cmdoption:: -l, --loglevel\n\n Logging level, choose between `DEBUG`, `INFO`, `WARNING`,\n `ERROR`, `CRITICAL`, or `FATAL`.\n\n"

enable_config_from_cmdline = True

get_options()

run(detach=False, logfile=None, pidfile=None, uid=None, gid=None, umask=None, working_directory=None, **kwargs)

supports_args = False

celery.bin.celerybeat.main()