fortify / fcli

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

Move `ncd-report` and `msp-report` commands #358

Closed rsenden closed 1 year ago

rsenden commented 1 year ago

We currently have fcli util ncd-report * and fcli util msp-report * commands. However, these license reporting commands don't fit very well alongside the other commands in the fcli util module, as these other commands are low-level utility commands.

The idea is to move these commands to a new report module, resulting in the following command structure:

Moving these commands to a dedicated module seems to be more appropriate, and gives us a good place to add more reporting commands.

Any reporting functionality provided by Fortify products will be covered in the respective product modules though, like fcli ssc report generate). As such, it's not clear yet whether there will be any more 'fcli-native' reports, in which case it may be overkill to introduce a new report module with just two sub-commands.

Ideas/suggestions/...?

psmf22 commented 1 year ago

I´d leave them in util unless there are plans to introduce more of these, a top level report command might lead to confusion with the product reports

rsenden commented 1 year ago

According to internal email conversation, there will likely be more license-related reports; so far there seem to be no plans for similar reports that are not related to licensing.

So, instead of having a generic report module, which as mentioned may cause some confusion (also because report is both a verb and entity), maybe we should instead have a dedicated license or licensing module?

fcli license msp-report ...
fcli licensing msp-report ...

Any preference for one of these, or alternative suggestions?