Skip to content

feat: add sentry event list command + events plural alias #633

@BYK

Description

@BYK

Summary

Add a list subcommand to sentry event to list events for a project, and register events as a plural alias (like issuesissue list). This is requested by users in CLI-Q3 telemetry (~6 events trying sentry event list).

Implementation Details

API Endpoint

GET /api/0/organizations/{org}/projects/{project}/events/ (project-scoped event listing)

New API Function

Add listProjectEvents to src/lib/api/events.ts:

  • Paginated response using apiRequestToRegion + parseLinkHeader
  • Return type: PaginatedResponse<SentryEvent[]>
  • Accept org slug, project slug, and standard pagination/query options

New Command

Create src/commands/event/list.ts:

  • Register as list in src/commands/event/index.ts route map
  • Accept optional [<org>/<project>] target positional (auto-detect from DSN/defaults)
  • Support --limit, --cursor, --query, --json, --fields flags
  • Follow existing list command patterns (org-list dispatch or standalone pagination)

Plural Alias

In src/app.ts:

  • Add events: eventListCommand to the top-level routes (import listCommand from event/list.ts)
  • Add events: true to hideRoute
  • Add events: "event" to PLURAL_TO_SINGULAR

References

  • List command patterns: src/commands/issue/list.ts, src/commands/trace/list.ts
  • Event types: src/types/sentry.ts (SentryEvent)
  • Plural alias pattern: see existing issues, traces, logs in src/app.ts

Context

A temporary synonym suggestion for event/list exists in src/lib/command-suggestions.ts. Remove that entry once this command is implemented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels
    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