Skip to content

Command line tool

python -m cattle_grid

Usage:

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

Options:

  --config_file TEXT
  --help              Show this message and exit.

python -m cattle_grid account

Used to manage accounts associated with cattle_grid

Usage:

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

Options:

  --help  Show this message and exit.
python -m cattle_grid account list

Lists existing accounts

Usage:

python -m cattle_grid account list [OPTIONS]

Options:

  --help  Show this message and exit.
python -m cattle_grid account new

Creates a new account

Usage:

python -m cattle_grid account new [OPTIONS] NAME PASSWORD

Options:

  --help  Show this message and exit.

python -m cattle_grid async-api

Usage:

python -m cattle_grid async-api [OPTIONS]

Options:

  --filename TEXT
  --component TEXT  Restrict to a component. Currently allowed ap
  --help            Show this message and exit.

python -m cattle_grid block

Allows management of the level 0 blocklist of cattle_grid. These are the instances that you consider so bad you want them blocked on the lowest level possible.

Usage:

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

Options:

  --help  Show this message and exit.
python -m cattle_grid block add

Adds domain to the current list of domain blocks

Usage:

python -m cattle_grid block add [OPTIONS] DOMAIN

Options:

  --help  Show this message and exit.
python -m cattle_grid block compare

Compares the current block list with the one provided by source

Usage:

python -m cattle_grid block compare [OPTIONS]

Options:

  --source TEXT  URL or file to import blocklist from
  --help         Show this message and exit.
python -m cattle_grid block empty

Sets the blocklist to the empty set

Usage:

python -m cattle_grid block empty [OPTIONS]

Options:

  --help  Show this message and exit.
python -m cattle_grid block import

Imports the blocklist from source. By default the blocklist is merged with current one. By specifying the allow flag, one can overwrite the current blocklist.

Usage:

python -m cattle_grid block import [OPTIONS]

Options:

  --source TEXT  URL or file to import blocklist from
  --overwrite    Use to overwrite the existing blocklist instead of just
                 adding to it
  --help         Show this message and exit.
python -m cattle_grid block list

Prints the current blockllist in alphabetical order

Usage:

python -m cattle_grid block list [OPTIONS]

Options:

  --help  Show this message and exit.
python -m cattle_grid block remove

Removes domain from the current list of domain blocks

Usage:

python -m cattle_grid block remove [OPTIONS] DOMAIN

Options:

  --help  Show this message and exit.

python -m cattle_grid create-db-migration

Creates a database migration; run after editing models

Usage:

python -m cattle_grid create-db-migration [OPTIONS]

Options:

  --db_uri TEXT
  --name TEXT
  --help         Show this message and exit.

python -m cattle_grid extensions

Usage:

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

Options:

  --help  Show this message and exit.
python -m cattle_grid extensions async-api

Usage:

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

Options:

  --help  Show this message and exit.

python -m cattle_grid keys

Allows the management of public keys

Usage:

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

Options:

  --help  Show this message and exit.
python -m cattle_grid keys clear

Usage:

python -m cattle_grid keys clear [OPTIONS]

Options:

  --all_flag  Remove all known public keys
  --help      Show this message and exit.

python -m cattle_grid new-config

Creates a new configuration file

Usage:

python -m cattle_grid new-config [OPTIONS]

Options:

  --force  Used to override the old configuration file
  --help   Show this message and exit.

python -m cattle_grid openapi

Usage:

python -m cattle_grid openapi [OPTIONS]

Options:

  --filename TEXT
  --component TEXT  Restrict to a component. Currently allowed auth or ap
  --help            Show this message and exit.

python -m cattle_grid stat

Displays statistical information about cattle_grid

Usage:

python -m cattle_grid stat [OPTIONS]

Options:

  --help  Show this message and exit.

python -m cattle_grid upgrade-db

Usage:

python -m cattle_grid upgrade-db [OPTIONS]

Options:

  --db_uri TEXT
  --help         Show this message and exit.