Having a help attribute for each command

[faraazahmad]

Either we could implement the help for the command using --help parameter or we could make something more detailed, a tiny bit less detailed than man pages, something similar to this (Elixir REPL) would be really nice.

Your feedback is highly appreciated

[pknight24]

I manage an open source project written in Rust, and we use a specific package that organizes the 'help' flag for each terminal command that we wrote. This makes life much easier than rewritting the 'help' output entirely for each command. For shellrb, I was thinking that we could have a Help class in a file help.rb, that keeps track of a command's usage, different parameters that it can take, maybe even the commands version number and author. This would also force for a uniform style for each commands 'help' output, which would make everything much more readable. I would be willing to work on this after I finish the 'touch' command.

[faraazahmad]

That seems like a nice idea! I was thinking of a similar thing. I was thinking to organise each package into its own folder and have its meta data in a yaml file, like basic usage, examples etc.

But that would make for a lot of work. Your idea sounds doable in a fair amount of time.

that keeps track of a command's usage

^ I didn't quite understand how

[pknight24]

Sorry, I worded that a bit weird. I just meant that we could give a couple examples of how to use the command.