PSPF CLI (pspfctl)

PSPF includes a command-line interface tool, pspfctl, to manage and inspect your stream processing applications.

Installation

The CLI is included with the pspf package. If you installed via pip:

pspfctl --help

Commands

Inspecting Data

You can inspect the contents of the LocalLog directly on disk, without running a worker. This is useful for debugging corruption or checking data state in environment where you have file access.

# View first 10 records of partition 0
pspfctl inspect ./data --partition 0 --limit 10

# View last 5 records (tail)
pspfctl inspect ./data --partition 0 --tail --limit 5

Remote Control

If your worker has the Admin API enabled (default port 8001), you can control it remotely.

Check Status

pspfctl status --url http://localhost:8001
# Output: ✅ Worker Online: {'status': 'ok', 'worker_state': 'running'}

Cluster Status

View the global cluster topology and partition assignments.

pspfctl cluster-status

Consumer Group Management

List groups or reset offsets for a specific stream.

# List all groups for a stream
pspfctl groups orders

# Reset a group's offset to the beginning (0) or end ($)
pspfctl reset orders my-group 0

Managing DLQs

Inspect, purge, or replay messages from a Dead Letter Queue.

# View last 5 messages in DLQ
pspfctl dlq-inspect orders --limit 5

# Replay messages back to the main stream
pspfctl replay orders my-group --limit 100

# Clear the DLQ
pspfctl dlq-purge orders