Skip to main content

Pulse CLI Reference

All Pulse CLI commands are available under the shift-cli pulse namespace.

Global Flags

FlagDescription
--jsonOutput structured JSON (for agent consumption)
--quietSuppress stdout, exit codes only

Events

List events

shift-cli pulse events list

JSON output:

shift-cli pulse events list --json
[
{
"id": "e1f2g3h4",
"name": "page.viewed",
"properties": {"page": "/dashboard"},
"userId": "user-abc",
"sessionId": "sess-xyz",
"timestamp": "2026-03-05T12:00:00.000Z"
}
]

Track a single event

shift-cli pulse events track

Interactive prompts will guide you through providing the event name, properties, user ID, and session ID.

Batch ingest events

shift-cli pulse events batch

Accepts a JSON file or piped input containing an array of events for batch ingestion.

Reports

Top events

shift-cli pulse reports top

Displays the most frequently occurring events.

JSON output:

shift-cli pulse reports top --json
[
{
"name": "page.viewed",
"count": 142
},
{
"name": "button.clicked",
"count": 87
},
{
"name": "api.called",
"count": 53
}
]