Skip to content

Command line tool

python -m cattle_grid.extensions

Tooling for managing extensions

Usage:

python -m cattle_grid.extensions [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • async-api: Generates the async api schema for the extension
  • load: Loads an extension
  • openapi: Generates the openapi schema for the extension
  • run: Runs the extension as an independent server process.

python -m cattle_grid.extensions async-api

Generates the async api schema for the extension

Usage:

python -m cattle_grid.extensions async-api [OPTIONS] MODULE

Options:

Name Type Description Default
--filename text Filename to write to None
--help boolean Show this message and exit. False

python -m cattle_grid.extensions load

Loads an extension

Usage:

python -m cattle_grid.extensions load [OPTIONS] MODULE

Options:

Name Type Description Default
--help boolean Show this message and exit. False

python -m cattle_grid.extensions openapi

Generates the openapi schema for the extension

Usage:

python -m cattle_grid.extensions openapi [OPTIONS] MODULE

Options:

Name Type Description Default
--filename text Filename to write to None
--help boolean Show this message and exit. False

python -m cattle_grid.extensions run

Runs the extension as an independent server process. The configuration is taken from the same files as cattle_grid. Thus these must be present.

Usage:

python -m cattle_grid.extensions run [OPTIONS] MODULE

Options:

Name Type Description Default
--host text Host to run on 0.0.0.0
--port integer Port to run on 80
--reload_dir text Reload on changes in directory None
--no_broker boolean Set to run without included broker False
--help boolean Show this message and exit. False