python-fire icon indicating copy to clipboard operation
python-fire copied to clipboard

Feature request to show help output inline

Open tbrodbeck opened this issue 5 years ago • 5 comments

It would be great if the output help command would not cover the whole screen and after that disappear, but if it would just append its output to the command line like most unix commands do output their help info. You could also add this as an option, in case users need the current functionality.

tbrodbeck avatar Sep 25 '20 14:09 tbrodbeck

Yes I'd prefer the current man page style output to be add to man and have an inline output as the default. I'm not sure how it could install the man page though, perhaps it'd be something that could be done via setuptools?

shangxiao avatar Oct 21 '20 10:10 shangxiao

As a workaround for now, you can pipe the help to cat to have it appear inline. e.g. python example.py -h | cat

dbieber avatar Oct 21 '20 12:10 dbieber

"Short help" vs "long help" is a really good feature idea, especially for large classes, but it's not clear to me how to specifically implement it.

nfultz avatar Oct 21 '20 14:10 nfultz

In a broader scope, it would be really beneficial to let people customize/tweak some settings ON/OFF etc. I'm currently using Fire to help execute REPL commands parsed with shlex, and I would really like to customize help message output (not a pager, default stdout). I cannot really think of a usecase where you would want paged help messages for a CLI tool ?

Are there any plans for supporting this in the near future ? Thanks !

Spriithy avatar Nov 02 '20 18:11 Spriithy

No plans to add those configs in the next couple of months. Will revisit in the new year.

dbieber avatar Nov 05 '20 16:11 dbieber