search

getsentry / sentry-cli

A command line utility to work with Sentry.
https://docs.sentry.io/cli/
BSD 3-Clause "New" or "Revised" License
900 stars 221 forks source link

Structured output feature #2128

Open seanhoughtonatvi opened 2 months ago

seanhoughtonatvi commented 2 months ago

The output of the CLI is in human-readable tabular format. I looked through the code and the docs and it appears that there is no way to get csv, json, yaml, or any other structured output. This makes using the CLI as part of a script much more challenging.

I would like to be able to provide an --output-format=json argument and get tabular data formatted as a json list of objects.

szokeasaurusrex commented 2 months ago

Hi @seanhoughtonatvi, thank you for the suggestion. For which specific command(s) are you requesting this feature?

seanhoughtonatvi commented 2 months ago

I was looking in to using sentry-cli to create a weekly summary report that includes a list of unresolved issues rather than numerical totals like the built-in summary. This would use sentry-cli issues list --project xxxx.

Any command that uses https://github.com/getsentry/sentry-cli/blob/master/src/utils/formatting.rs#L27 would probably benefit from structured output so it can be piped into tools like jq.

I've since realized that there's no command to actually retrieve information about a specific issue (!) - so it looks like this tool isn't really intended as a general-purpose CRUD interface to Sentry. I'm going to change my approach and generate an SDK with swagger-codegen and write an application that uses the REST interface rather than a script. The CLI would have made a prototype easier.

szokeasaurusrex commented 2 months ago

Ah understood. Yeah, the sentry-cli only performs a subset of the actions available from the Sentry web API.

If the structured output feature cannot help you anyways with what you are trying to accomplish, I will just leave the issue open on our backlog with low priority. If more folks request this feature, we can increase the priority.

If having the ability to query information about a single issue in the CLI would be helpful for you, you can feel free to open another feature request

szokeasaurusrex commented 3 weeks ago

Structured output would also be helpful for the JavaScript bundler plugins – specifically, we would output to JSON