CLI

Command Line Interface documentation.

Usage

Assuming knots-hub and its dependencies are installed:

python -m knots-hub --help

Commands

--help

usage: knots_hub [-h] [--debug] [--no-coloring] [--log-environ]
                 [--force-local-restart]
                 {kloch,__applyupdate,uninstall} ...

Manage and access the knots pipeline for its users.

positional arguments:
  {kloch,__applyupdate,uninstall}

optional arguments:
  -h, --help            show this help message and exit
  --debug               True to execute the CLI in debug mode. Usually with
                        more verbose logging.
  --no-coloring         Disable colored logging, in case your system doesn't
                        support it.
  --log-environ         True will log the current system environment variable.
                        Also need the debug flag.
  --force-local-restart
                        Force a restart with the locally installed executable,
                        if any.

kloch

Directly call the kloch tool that is integrated in the hub.

All arguments are directly passed to the kloch CLI so check the kloch documentation for details.

uninstall

usage: knots_hub uninstall [-h] [--debug] [--no-coloring] [--log-environ]
                           [--force-local-restart]

Uninstall the hub from the user system.

optional arguments:
  -h, --help            show this help message and exit
  --debug               True to execute the CLI in debug mode. Usually with
                        more verbose logging.
  --no-coloring         Disable colored logging, in case your system doesn't
                        support it.
  --log-environ         True will log the current system environment variable.
                        Also need the debug flag.
  --force-local-restart
                        Force a restart with the locally installed executable,
                        if any.