search

gojek / proctor

A Developer-Friendly Automation Orchestrator
Apache License 2.0
123 stars 42 forks source link

Intuitive help for procs #32

Open olttwa opened 6 years ago

olttwa commented 6 years ago

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 commented 6 years ago

@raeoks @vjdhama thoughts? ^^

detj commented 6 years ago

@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 ?

vjdhama commented 6 years ago

@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.