Command line tool¶
python -m cattle_grid¶
Usage:
Options:
python -m cattle_grid account¶
Used to manage accounts associated with cattle_grid
Usage:
Options:
python -m cattle_grid account delete¶
Lists existing accounts
Usage:
Options:
python -m cattle_grid account list¶
Lists existing accounts
Usage:
Options:
--actors If set, also lists the actors associated with each account
--help Show this message and exit.
python -m cattle_grid account modify¶
Modifies an account
Usage:
Options:
--add_permission TEXT Adds the permission to the account
--remove_permission TEXT Adds the permission to the account
--help Show this message and exit.
python -m cattle_grid account new¶
Creates a new account
Usage:
Options:
--admin Set the admin permission
--permission TEXT Adds the permission to the account
--help Show this message and exit.
python -m cattle_grid actor¶
Used to manage actors
Usage:
Options:
python -m cattle_grid actor list¶
Usage:
Options:
python -m cattle_grid actor modify¶
Adds a group to the actor
Usage:
Options:
python -m cattle_grid actor prune¶
Usage:
Options:
python -m cattle_grid actor show¶
Usage:
Options:
python -m cattle_grid async-api¶
Usage:
Options:
--filename TEXT
--for_docs Generate schema for use in documentation
--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:
Options:
python -m cattle_grid block add¶
Adds domain to the current list of domain blocks
Usage:
Options:
python -m cattle_grid block compare¶
Compares the current block list with the one provided by source
Usage:
Options:
python -m cattle_grid block empty¶
Sets the blocklist to the empty set
Usage:
Options:
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:
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:
Options:
python -m cattle_grid block remove¶
Removes domain from the current list of domain blocks
Usage:
Options:
python -m cattle_grid create-db-migration¶
Creates a database migration; run after editing models
Usage:
Options:
python -m cattle_grid extensions¶
Commands for managing extensions
Usage:
Options:
python -m cattle_grid extensions async-api¶
Generates the async api schema for the extension
Usage:
Options:
python -m cattle_grid extensions load¶
Loads an extension
Usage:
Options:
python -m cattle_grid extensions openapi¶
Generates the openapi schema for the extension
Usage:
Options:
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:
Options:
--host TEXT Host to run on
--port INTEGER Port to run on
--reload_dir TEXT Reload on changes in directory
--no_broker Set to run without included broker
--help Show this message and exit.
python -m cattle_grid jsonschema¶
Usage:
Options:
python -m cattle_grid keys¶
Allows the management of public keys
Usage:
Options:
python -m cattle_grid keys clear¶
Usage:
Options:
python -m cattle_grid new-config¶
Creates a new authorization configuration, including generating a public and private key.
Argument is the actor_id for the fetch actor, e.g. http://cattle_grid/fetch_actor
Usage:
Options:
--config_file TEXT Filename to save the configuration to
--username TEXT Specify a username for the fetch actor. Otherwise it is
automatically generated
--force Used to override the old configuration file
--help Show this message and exit.
python -m cattle_grid openapi¶
Usage:
Options:
--filename TEXT
--for_docs Generate schema for use in documentation
--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:
Options:
python -m cattle_grid upgrade-db¶
Usage:
Options: