CLI documentation

qosst - CLI interface

qosst [-h] [--version] [-v] {info,versions,shell,motd,credits,hardware} ...

-h, --help - show this help message and exit
--version - show program’s version number and exit
-v, --verbose - Level of verbosity. If none, only critical errors will be prompted. -v will add warnings and errors, -vv will add info and -vvv will print all debug logs. (default: 0)

Display info on the package

qosst info [-h]

Start a shell

qosst shell [-h]

Print MOTD

qosst motd [-h]

Credits of QOSST

qosst credits [-h]

List the hardware of a given package

qosst hardware [-h] package

qosst configuration [-h] {create} ...

Create a configuration file

qosst configuration create [-h] [-f FILE] [--override]

-h, --help - show this help message and exit
-f FILE, --file FILE - Path of the file to create. Default : config.toml. (default: config.toml)
--override - If present, this will override the current configuration file at the given path, if it exists.

qosst auth [-h] {generate-falcon} ...

Generate a Falcon keypair.

qosst auth generate-falcon [-h] [-n SIZE] [-d DIRECTORY] [-s SECRET_KEY_NAME]
                           [-p PUBLIC_KEY_NAME] [-f]

-h, --help - show this help message and exit
-n SIZE, --size SIZE - Size of the falcon key. (default: 512)
-d DIRECTORY, --directory DIRECTORY - Directory where to save keys. (default: keys)
-s SECRET_KEY_NAME, --secret-key-name SECRET_KEY_NAME - Name of the secret key file. (default: secret_key.json)
-p PUBLIC_KEY_NAME, --public-key-name PUBLIC_KEY_NAME - Name of the public key file. (default: public_key.json)
-f, --force - Overwrite existing files.