Skip to main content
Version: Latest

HelpList

HelpList is a structure containing information about commands, features, and other details about a module. It includes descriptions of each module, feature, or command, their arguments, usage examples, and explanations. This tool helps users navigate the commands and features of a module and use its functionality correctly.

Starting from version 2.2, the HelpList is defined in the manifest.yaml file.

sections​

The module's HelpList. Contains descriptions of all commands and features, divided into sections. This is a required field.

Format:

manifest.yaml
sections:
  <section_1>:
    description: <section description> # optional
    commands:                          # list of commands (optional if only features are present)
      - names: [<alias_1>, <alias_2>]  # command aliases. What you need to type for the command to work. Specified without a prefix
        description: <command description>
        arguments:
          - {text: <argument description>, req: Yes|No} # list of arguments, if any
    features:                          # list of features (optional)
      - title: <title>
        description: <description>

Section _​

If the module contains only one section, it is specified under _. This is the main section and is always displayed first.

commands​

A list of all available commands in the section.

Command format:

  • names — list of command aliases
  • description — brief description
  • arguments (optional) — list of arguments

Arguments:

  • text — description of the argument (how it appears in usage)
  • req — Yes if the argument is required, No if not

Example:

commands:
  - names: [mdelay, md]
    arguments:
      - {text: delay, req: No}
    description: Set/view delay

features​

An optional list of module features. Displayed after commands.

Format:

features:
  - title: Title
    description: Description

Multiple sections​

You can add additional sections with descriptions and their own commands. For example:

sections:
  _: # main
    commands: [...]
  logging: # additional
    description: Commands for logging
    commands: [...]