Skip to content

Missing help for built-in commandsΒ #1335

Closed

Description

@fmbenhassine

Initially reported here: #1271 (comment) by @3ric-T.


It seems that the documentation is not consistent with the behaviour of help command:

Typing <command> -h or <command> --help shows more information about a command, including the available parameters, their type, whether they are mandatory or not, and other details.

Currently, with either a built-in command or a new one, we have:

  • with built-in commands
$>help --help
AVAILABLE COMMANDS

Built-In Commands
        script: Execute commands from a script file
        help: Display help about available commands
        quit, exit: Exit the shell
        version: Show version info
        clear: Clear the terminal screen

$>version --help
Version: 4.0.1
  • with custom commands:
MyPrompt:> token --help

MyPrompt:> help token
NAME
        token - Display token information based on its name

SYNOPSIS
        token --tokenId String --help

OPTIONS
        --tokenId or -t String
        Token id, as defined in configuration
        [Optional, default = ]

        --help or -h
        help for token
        [Optional]

Activity

  1. added and removed
    status/need-triageTeam needs to triage and take a first look
    on Apr 3, 2026
  2. added this to the 4.0.2 milestone on Apr 3, 2026
  3. fmbenhassine commented on Apr 20, 2026

    @fmbenhassine
    ContributorAuthor

    This is not only a documentation issue, but also an incomplete help support from built-in commands (which do not provide a help string when invoked with the help flag). I will fix both for the upcoming 4.0.2.

    However, the following is a command implementation issue:

    MyPrompt:> token --help
    

    The token command should provide a help string to print when invoked with help flags (this is provided by default if the command extends AbstractCommand, see Option help)

  4. changed the title [-]Inconsistent documentation with the behaviour of help command[/-] [+]Missing help for built-in commands[/+] on Apr 20, 2026
  5. added a commit that references this issue on Apr 20, 2026
    fd656b6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions