Uploaded image for project: 'WildFly Elytron'
  1. WildFly Elytron
  2. ELY-2082

Optimise Tool Help Text

    XMLWordPrintable

Details

    Description

      You can see current help output from elytron-tool with the following:
      $ WILDFLY_HOME/bin/elytron-tool.sh --help

      Attached to this issue is the present help test from the tool when called with no arguments, it is already very verbose and new commands are in the process of being added making it even longer.

      We should switch to some kind of tiered help so by default we just show the stop level commands with a description and provide instructions to obtain help text on the individual commands.

      Secondly the wrapping of text makes us hard to read - even on a widescreen monitor.  If we could detect the width of the terminal window maybe we could more dynamically format the output.  Failing that maybe we should determine a minimum width to view the output and ensure we format cleanly within the width.

      We could also go further and ensure each command has a reference manual published from the Elytron project that can be referred to with a http link - or could the tool trigger loading the link?

       

      Attachments

        Activity

          People

            pberan@redhat.com Petr Beran
            darran.lofthouse@redhat.com Darran Lofthouse
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated: