Command Line Interface¶
Creating an organization¶
$ flask create_organization --help
Usage: flask create_organization [OPTIONS]
Create an organization.
Options:
--name TEXT Organization name (or UUID)
--help Show this message and exit.
Actually an organization name must be specified and is unique.
Example:
$ flask create_organization --name CASES
Name: CASES
Token: SylsDTZTBk2zAkg016vW_aCuO1XQDXPsxrLuI1TG7z5sYvUfRlVf5R4g6kDnLI_o-c5iqrswrWzPANDKXmtV7Q
The token is automatically generated. It will be required when using the
Stats
API (Stats) if the authentication is enabled
(Authentication).
TODO: Add a command to update a token (For the moment this can still be done with the API.)
Listing organizations¶
$ flask list_organizations
Name: CASES
Token: xL3F5M-g1HISeAccX_SrYG8ng3vPRbTByhwXIQufkBv1yCLG2eyc7Sl4cOtnDuGFMPQhniIFNIrZ6x-WRi9dNg
Name: CIRCL
Token: uJn2zUA361NANAz6dbtstAaAjq3hL28dscxzCjeUOHpIYC87K8nfOAPtRsTGAqT0iwzs7TEgq5DdD0kkwQDhmw
Drop all collections from the database¶
$ flask drop_all_collections --help
Usage: flask drop_all_collections [OPTIONS]
Drop all collections from the database.
Options:
--help Show this message and exit.
Will ask for confirmation and eventually drop all collections.
Pushing data¶
Pushing data to a central stats server.
Usage: flask push-stats [OPTIONS]
Push stats for the organization specified in parameter to an other stats
server.
Options:
--name TEXT Organization name
--help Show this message and exit.
This command can be executed for example with cron.
The address of the central stats server must be specified in the configuration
file (`instance/production.py`
).
Pulling data¶
Pulling data from a central stats server.