Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Note which options are required #223

Open
lorensr opened this issue Jun 14, 2022 · 0 comments
Open

[Feature Request] Note which options are required #223

lorensr opened this issue Jun 14, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@lorensr
Copy link
Contributor

lorensr commented Jun 14, 2022

Is your feature request related to a problem? Please describe.

When I run this, I'd like to know

  • whether the batch job started (it didn't)
  • if not, how to get it to start (add rest of required options)
$ tctl batch start --query "ExecutionStatus != 'foo'" --batch-type terminate --yes

NAME:
   tctl batch start - Start a batch operation job

USAGE:
   tctl batch start [command options] [arguments...]

OPTIONS:
   --query value, -q value          Query to get workflows for being executed this batch operation
   --reason value, -r value         Reason to run this batch job
   --batch-type value, --bt value   Types supported: terminate,cancel,signal
   --signal-name value, --sn value  Required for batch signal
   --input value, -i value          Optional input of signal
   --rps value                      RPS of processing (default: 50)
   --yes                            Optional flag to disable confirmation prompt (default: false)
   --help, -h                       show help (default: false)

Describe the solution you'd like

  • whether the batch job started (it didn't)

perhaps it is universally enough understood that printing usage means the command didn't work?

if not, how to get it to start (add rest of required options)

  • under USAGE and/or OPTIONS, denote which are required or which are optional. here is one convention: https://stackoverflow.com/a/21503966/627729
  • when entering a command without sufficient options, print the missing ones:
$ tctl batch start --query "ExecutionStatus != 'foo'" --batch-type terminate --yes

Missing required options:

   --reason value, -r value         Reason to run this batch job
@lorensr lorensr added the enhancement New feature or request label Jun 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant