This document describes Celery 2.3. For development docs, 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 0x59f0e60: --app>, <Option at 0x59f0128: --loader>, <Option at 0x59f0518: --config>, <Option at 0x44b1638: -q/--quiet>, <Option at 0x56d9098: -C/--no-color>)

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

prettify(n)

prettify_dict_ok_error(n)

prettify_list(n)

run(*args, **kwargs)

run_from_argv(prog_name, argv)

usage(command)

version = '2.3.5'

exception celery.bin.celeryctl.Error

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

args = '<task_name>'

option_list = (<Option at 0x59f0e60: --app>, <Option at 0x59f0128: --loader>, <Option at 0x59f0518: --config>, <Option at 0x44b1638: -q/--quiet>, <Option at 0x56d9098: -C/--no-color>, <Option at 0x44b0c20: -a/--args>, <Option at 0x56d9e60: -k/--kwargs>, <Option at 0x56d9440: --eta>, <Option at 0x58dc098: --countdown>, <Option at 0x57825a8: --expires>, <Option at 0x5782368: --serializer>, <Option at 0x5721c68: --queue>, <Option at 0x57093b0: --exchange>, <Option at 0x5740a28: --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'>, 'list': <class 'celery.bin.celeryctl.list_'>, '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, name=None)

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 0x59f0e60: --app>, <Option at 0x59f0128: --loader>, <Option at 0x59f0518: --config>, <Option at 0x44b1638: -q/--quiet>, <Option at 0x56d9098: -C/--no-color>, <Option at 0x5630950: -t/--timeout>, <Option at 0x5630c20: -d/--destination>)

run(*args, **kwargs)

say(direction, title, body='')

usage(command)

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

args = '<bindings>'

list_bindings(channel)

run(what, *_, **kw)

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 0x59f0e60: --app>, <Option at 0x59f0128: --loader>, <Option at 0x59f0518: --config>, <Option at 0x44b1638: -q/--quiet>, <Option at 0x56d9098: -C/--no-color>, <Option at 0x57406c8: -t/--task>)

run(task_id, *args, **kwargs)

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

option_list = (<Option at 0x59f0e60: --app>, <Option at 0x59f0128: --loader>, <Option at 0x59f0518: --config>, <Option at 0x44b1638: -q/--quiet>, <Option at 0x56d9098: -C/--no-color>, <Option at 0x5630950: -t/--timeout>, <Option at 0x5630c20: -d/--destination>)

run(*args, **kwargs)