fortify / fcli

fcli is a command-line utility for interacting with various Fortify products
https://fortify.github.io/fcli/
Other
31 stars 18 forks source link

FoD: remove all positional parameters and replace with options #453

Closed kadraman closed 11 months ago

kadraman commented 11 months ago

Given fcli <module> <entity> <action> <param>, does <param> represent <entity>? (i.e., in fcli ssc artifact download <id>, <id> refers to the artifact entity?

Should we maybe get rid of positional parameters altogether, or use them only in very specific cases like ‘get’ commands? Users now need to understand whether to use --appversion <appversion> or just <appversion>; might be easier to just always have --appversion …

It’s not clear what FCLIDEFAULT* environment variable name to use for specifying a default value for positional parameters

We could potentially have exclusive --app <name or id>, --app-id <id> and --app-name <name> options to allow for numeric app names; this is more difficult/impossible with positional parameters

kadraman commented 11 months ago

Proposal is to remove positional parameters where they are confusing. This is likely in the following areas: