relay events list

Loads your relay.ts and lists recent executions in a table. Newest first.

Usage

relay events list [--json] [--limit <n>] [--dir <path>]

Options

Flag	Default	Description
`--json`	false	Output JSON instead of a formatted table
`--limit <n>`	all	Show only the first N executions
`--dir`	current directory	Directory containing `relay.ts`

Requirements

A relay.ts in the target directory, exporting relay (see relay init)

Examples

List all executions

$ relay events list

✔ stripe.charge.succeeded       attempt 1  2024-01-15T10:30:45.123Z  exec_abc123xyz
✔ test.ping                     attempt 1  2024-01-15T10:28:12.456Z  exec_def456uvw
✖ github.push                   attempt 2  2024-01-15T10:25:00.789Z  exec_ghi789rst
✔ stripe.refund.created         attempt 1  2024-01-15T10:22:33.012Z  exec_jkl012mno

Columns (left to right):

Status icon (✔/✖/…)
Event type
Attempt number
Creation timestamp
Execution ID

Limit results

Show only the last 5 executions:

$ relay events list --limit 5

✔ stripe.charge.succeeded  attempt 1  2024-01-15T10:30:45.123Z  exec_abc123xyz
✔ test.ping                attempt 1  2024-01-15T10:28:12.456Z  exec_def456uvw
✖ github.push              attempt 2  2024-01-15T10:25:00.789Z  exec_ghi789rst
✔ stripe.refund.created    attempt 1  2024-01-15T10:22:33.012Z  exec_jkl012mno
✔ test.fail                attempt 3  2024-01-15T10:20:15.345Z  exec_pqr345stu

JSON output

$ relay events list --json --limit 2

[
  {
    "id": "exec_abc123xyz",
    "eventId": "evt_1234567890",
    "eventType": "stripe.charge.succeeded",
    "status": "completed",
    "attempt": 1,
    "createdAt": "2024-01-15T10:30:45.123Z",
    "completedAt": "2024-01-15T10:30:46.357Z"
  },
  {
    "id": "exec_def456uvw",
    "eventId": "test_5678",
    "eventType": "test.ping",
    "status": "completed",
    "attempt": 1,
    "createdAt": "2024-01-15T10:28:12.456Z",
    "completedAt": "2024-01-15T10:28:12.500Z"
  }
]

Status indicators

✔ (completed) — execution finished successfully
✖ (failed) — execution failed with an error
… (pending) — still running, or waiting on a scheduled retry

Next steps

To inspect a specific execution in detail:

relay inspect exec_abc123xyz

To replay a failed execution:

relay replay exec_abc123xyz

relay events list

On this page