search

infamousjoeg / cybr-cli

A "Swiss Army Knife" command-line interface (CLI) for easy human and non-human interaction with @CyberArk suite of products.
Apache License 2.0
71 stars 15 forks source link

mark required parameters in help output #85

Closed jodyhuntatx closed 3 years ago

jodyhuntatx commented 3 years ago

As an impatient developer of workflows I would like to not have to read documentation ever and would like the cli help to tell me exactly which parameters are required for example:

cybr safes add -s foo fails because a description is required. But you only discover that through trial and error. Good job documenting defaults btw.

AndrewCopeland commented 3 years ago

So them returned response is:

cybr safes add -s something
Error: required flag(s) "desc" not set
Usage:
  cybr safes add [flags]

Flags:
  -P, --auto-purge        Whether to automatically purge accounts after a number of records is met
      --cpm string        Set the Managing CPM user to something other than PasswordManager (default "PasswordManager")
      --days int          Number of days to retain password versions for (default 7)
  -d, --desc string       Description of the safe created
  -h, --help              help for add
  -l, --location string   The location of the Safe in the Secure Digital Vault (default "\\")
  -O, --olac              Enable object-level access control (OLAC) on safe (cannot be reversed)
  -s, --safe string       Safe name to create

Global Flags:
      --verbose   To enable verbose logging

required flag(s) "desc" not set

The description field is required by the CLI. Can this issue be closed?