idank / explainshell

match command-line arguments to their help text
GNU General Public License v3.0
13.17k stars 787 forks source link

[feature request] a simple theme making output easier to parse via shell scripts #250

Open meleu opened 4 years ago

meleu commented 4 years ago

@shivansh offered an interesting solution for the (quite frequent) requests for a CLI version of explainshell.

However, the output is kinda weird, as we can see the example below for ls -ltr (the explanation of ls is away from it):

ls(1)

-ltr

list directory contents

-l     use a long listing format

-t     sort by modification time, newest first

-r, --reverse
       reverse order while sorting

If there was a, let's say, frugal theme (along with the Light and Dark ones), where each explanation became right after the command/option it would be neater to parse and generate clearer output for CLI lovers. Something like this:

ls(1)

list directory contents

-ltr

-l     use a long listing format

-t     sort by modification time, newest first

-r, --reverse
       reverse order while sorting

Related:

4

60

76

94

241