search

sailpoint-oss / sailpoint-cli

The SailPoint Command Line Interface (CLI) makes it easy to interact with SailPoint's SaaS Platform in a programmatic way. Many functions that use to be accomplished through tools like Postman or from custom scripts can now be done directly on the command line with minimal setup.
https://developer.sailpoint.com/discuss
MIT License
24 stars 18 forks source link

[Feature] Output parameter #59

Open yannick-beot-sp opened 1 year ago

yannick-beot-sp commented 1 year ago

Currently, the CLI mostly store the output of a command to files (SP-Config, transforms, reports, etc.) This prevents from piping the output between different set of commands (jq, grep, etc.) or readability (after all, JSON is not that readable).

Azure CLI does have a --output/-o parameter (cf. https://learn.microsoft.com/en-us/cli/azure/format-output-azure-cli) that allows different type of format for any output. It also has a --query allowing JSONPath filtering/transformation so we do not have to rely on jq or requivalent.

Finally, it is possible to define a default output.

SailPoint CLI would greatly benefit from such capability.

colin-mckibben-sp commented 1 year ago

@luke-hagar-sp We should look into this. We could probably just update all the list/get/download commands to print to stdout if no filepath is provided. I don't think that will be a breaking change. Thoughts?

LukeHagar commented 1 year ago

I'm thinking a global configuration option to specify output preference, standardized output formats supported via STDOUT, we would need to adjust some commands to allow for a more standardized output vs what is already implemented