This document describes the current stable version of Celery (3.1). For development docs, go here.

celery.bin.beat

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, --scheduler

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

--max-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.beat.beat(app=None, get_app=None, no_color=False, stdout=None, stderr=None, quiet=False, on_error=None, on_usage_error=None)

Start the beat periodic task scheduler.

Examples:

celery beat -l info
celery beat -s /var/run/celery/beat-schedule --detach
celery beat -S djcelery.schedulers.DatabaseScheduler

doc = 'Start the beat periodic task scheduler.\n\n Examples::\n\n celery beat -l info\n celery beat -s /var/run/celery/beat-schedule --detach\n celery beat -S djcelery.schedulers.DatabaseScheduler\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