prosEO CLI 4_Help

Command Line Interface (CLI) Guide - Help

The help command is used to retrieve general information, that is, a complete help page as it is accessible here.

At the same time, -h or --help can be used as an option to retrieve information on commands and sub-commands.

Help as a Command

The help command can retrieve the complete help page:

prosEO (no mission)> help
The general syntax for commands is:

  command [subcommand...] [option...] [parameter...]

Commands can be entered after the "prosEO>" command prompt. They can also be invoked on the shell command line
...

The full help text is omitted here, as a link is provided above.

Help as an Option

Adding the option -h or --help after a command or a subcommand provides information on its usage, for example

prosEO (no mission)> exit --help
Terminate the Command Line Interface
Options:
    -h, --help        Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
    -- none --
Subcommands:
    -- none --

prosEO (no mission)> mission show -h
List all configured missions or only the given one
Options:
        --format      The output format (one of { JSON, XML, YAML }; default value YAML [human readable])
    -h, --help        Show help information for the current command/subcommand level (top level commands, when called from the shell command line)
Positional parameters:
    missionCode       (optional) The code of the mission to list
Subcommands:
    -- none --
prosEO (no mission)>

Note: Some commands have sub-commands of sub-commands. The option -h can retrieve information about those as well.