Command Line Interface

The SKA-DLM provides a concise command line interface (CLI) implemented using the typer package. After installation the CLI is available as a hierarchical command interface simply starting with:

> ska-dlm

The output of which looks like:

../_images/ska-dlm.png

As can be seen the CLI features highlighting and on-line help:

../_images/ska-dlm-help.png

Typer also provides command line completion and those are the two first options shown along with the --help option. Just to show a couple more examples of the help hierarchy for the storage manager.

This is showing the available sub-commands of ska-dlm storage:

../_images/ska-dlm-storage.png

The following is showing the actual command options for the ska-dlm storage init-location command:

../_images/ska-dlm-location.png

All options of the SKA-DLM can be explored and used in this way. For an example, see our Command Line Interface guide.