This document describes an older version of Celery (2.2). For the latest stable version please go here.

celeryctl - celery.bin.celeryctl

class celery.bin.celeryctl.Command(app=None, no_color=False)

args = ''

create_parser(prog_name, command)

error(s)

help = ''

option_list = (<Option at 0x6fbe5a8: --app>, <Option at 0x6e416c8: --loader>, <Option at 0x6e41998: --config>, <Option at 0x7019560: -q/--quiet>, <Option at 0x7019518: -C/--no-color>)

out(s, fh=<open file '<stdout>', mode 'w' at 0x7f6f5dd7f150>)

prettify(n)

prettify_dict_ok_error(n)

prettify_list(n)

run(*args, **kwargs)

run_from_argv(prog_name, argv)

usage(command)

version = '2.2.10'

exception celery.bin.celeryctl.Error

class celery.bin.celeryctl.apply(app=None, no_color=False)

args = '<task_name>'

option_list = (<Option at 0x6fbe5a8: --app>, <Option at 0x6e416c8: --loader>, <Option at 0x6e41998: --config>, <Option at 0x7019560: -q/--quiet>, <Option at 0x7019518: -C/--no-color>, <Option at 0x7019440: -a/--args>, <Option at 0x70193f8: -k/--kwargs>, <Option at 0x70193b0: --eta>, <Option at 0x7019368: --countdown>, <Option at 0x7019320: --expires>, <Option at 0x70192d8: --serializer>, <Option at 0x7019290: --queue>, <Option at 0x7019248: --exchange>, <Option at 0x7019200: --routing-key>)

run(name, *_, **kw)

class celery.bin.celeryctl.celeryctl(app=None, get_app=None)

commands = {'status': <class 'celery.bin.celeryctl.status'>, 'help': <class 'celery.bin.celeryctl.help'>, 'inspect': <class 'celery.bin.celeryctl.inspect'>, 'purge': <class 'celery.bin.celeryctl.purge'>, 'result': <class 'celery.bin.celeryctl.result'>, 'apply': <class 'celery.bin.celeryctl.apply'>}

execute(command, argv=None)

handle_argv(prog_name, argv)

celery.bin.celeryctl.command(fun)

class celery.bin.celeryctl.help(app=None, no_color=False)

run(*args, **kwargs)

usage(command)

celery.bin.celeryctl.indent(s, n=4)

class celery.bin.celeryctl.inspect(app=None, no_color=False)

choices = {'scheduled': 1.0, 'reserved': 1.0, 'active': 1.0, 'cancel_consumer': 1.0, 'active_queues': 1.0, 'add_consumer': 1.0, 'stats': 1.0, 'revoked': 1.0, 'enable_events': 1.0, 'ping': 0.2, 'disable_events': 1.0, 'registered_tasks': 1.0}

option_list = (<Option at 0x6fbe5a8: --app>, <Option at 0x6e416c8: --loader>, <Option at 0x6e41998: --config>, <Option at 0x7019560: -q/--quiet>, <Option at 0x7019518: -C/--no-color>, <Option at 0x7019170: -t/--timeout>, <Option at 0x7019128: -d/--destination>)

run(*args, **kwargs)

say(direction, title, body='')

usage(command)

celery.bin.celeryctl.main()

celery.bin.celeryctl.pluralize(n, text, suffix='s')

class celery.bin.celeryctl.purge(app=None, no_color=False)

run(*args, **kwargs)

class celery.bin.celeryctl.result(app=None, no_color=False)

args = '<task_id>'

option_list = (<Option at 0x6fbe5a8: --app>, <Option at 0x6e416c8: --loader>, <Option at 0x6e41998: --config>, <Option at 0x7019560: -q/--quiet>, <Option at 0x7019518: -C/--no-color>, <Option at 0x70191b8: -t/--task>)

run(task_id, *args, **kwargs)

class celery.bin.celeryctl.status(app=None, no_color=False)

option_list = (<Option at 0x6fbe5a8: --app>, <Option at 0x6e416c8: --loader>, <Option at 0x6e41998: --config>, <Option at 0x7019560: -q/--quiet>, <Option at 0x7019518: -C/--no-color>, <Option at 0x7019170: -t/--timeout>, <Option at 0x7019128: -d/--destination>)

run(*args, **kwargs)