proctor icon indicating copy to clipboard operation
proctor copied to clipboard

Intuitive help for procs

Open olttwa opened this issue 6 years ago • 3 comments

As a user, I want procs help to be more intuitive.

Currently, If I fetch all procs using proctor list, and I need help for run-sample proc, I need to type command: proctor describe run-sample. That's unintuitive.

Instead, proctor help run-sample or proctor run-sample --help would be more intuitive for displaying help.

olttwa avatar Oct 16 '18 07:10 olttwa

@raeoks @vjdhama thoughts? ^^

olttwa avatar Oct 16 '18 07:10 olttwa

@olttwa Yes, that'd better. Also support proctor --help. Right now, running proctor --help throws the error Error reading proctor config if I don't have a config setup yet. Help routine should not check for presence of config.

Do we have a proctor --version command ?

detj avatar Oct 16 '18 11:10 detj

@olttwa I prefer proctor run-sample --help over proctor help run-sample just because that's kind of unspoken standard for checking options of a subcommand and people expect it to be present by default.

vjdhama avatar Oct 16 '18 18:10 vjdhama