probe Command
Table of Contents
Overview
The probe command manages probe runs. Observation commands such as watch, trace, monitor, and top register probes inside the target when they execute, and probe is the unified control entry point for those probes: list registrations, inspect recent events, stop running probes, and clean up old ones.
Use list, status, inspect, stop, and cleanup to filter probes by target, type (watch, trace, etc.), or status - useful for reclaiming observations that were forgotten about so they do not keep weighing on the target.
Syntax
peeka-cli probe <subcommand> [options]
Subcommands
| Subcommand | Description |
|---|---|
list |
List probe runs |
status --probe <id> |
Show probe status |
inspect --probe <id> |
Show probe details and recent events |
stop --probe <id> |
Stop a running probe |
cleanup |
Clean old probes |
Common options:
| Option | Description |
|---|---|
--target <id> |
Filter by or locate the owning target |
--type <type> |
Filter list by probe type, such as watch or trace |
--status <status> |
Filter list by status |
--events <n> |
Number of recent events returned by inspect, default 100 |
--all |
During cleanup, also clean created/paused probes; never active probes |
--older-than <duration> |
During cleanup, clean probes older than the duration; default 10m |
--format table/json |
Output format, default table |
Examples
peeka-cli probe list --target target_abcd1234
peeka-cli probe list --type watch --status active
peeka-cli probe inspect --probe probe_123 --events 20 --format json
peeka-cli probe stop --probe probe_123
peeka-cli probe cleanup --older-than 1h
Version History
| Version | Release Date | Changes |
|---|---|---|
| 0.1.16 | 2026-06-07 | Added the probe command group |