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

celery.bin.celery

Celery Command Line Interface.

class celery.bin.celery.App[source]

Application option.

convert(value, param, ctx)[source]

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call fail() with a descriptive message.

Parameters:

  • value – The value to convert.

  • param – The parameter that is using this type to convert its value. May be None.

  • ctx – The current context that arrived at this value. May be None.

name: str = 'application'

the descriptive name of this type

celery.bin.celery.main() → int[source]

Start celery umbrella command.

This function is the main entrypoint for the CLI.

Returns:

The exit code of the CLI.