Skip to content

issue list help text shows opaque <target> — should document supported patterns #267

@betegon

Description

@betegon

Problem

The usage line for sentry issue list currently reads:

USAGE
  sentry issue list [--query value] [--limit value] [--sort value] [--json] [--cursor value] [<target>]

<target> is opaque. Users don't know that multiple patterns are supported, or that the trailing / on org/ is significant syntax that changes behavior (enables cursor pagination, switches to org-wide listing).

A user recently tried sentry issue list sentry --cursor 100 expecting org-scoped pagination, but sentry (without trailing slash) is parsed as a project-search, which rejects --cursor. The error message mentions <org>/ but the significance of the trailing slash doesn't register.

Supported patterns today

Input Mode Behavior
(none) auto-detect DSN detection / config defaults
org/project explicit Single org and project
org/ org-all All projects in org (only mode supporting --cursor)
/project project-search Find project across all orgs
project project-search Find project across all orgs

Ideas

  • Show [<org>/<project>] in the usage line instead of [<target>]
  • Document the wildcard patterns somewhere visible — a table in fullDescription that --help renders, or similar
  • Make the trailing / significance more obvious in error messages when --cursor is rejected
  • Consider whether a bare string + --cursor should be interpreted as org-all mode rather than erroring

Context

Ref: user report where all three of sentry issue list sentry, sentry issue list 1, and sentry issue list javascript were tried with --cursor and all produced the same confusing error.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions