client Command
Table of Contents
Overview
The client command creates and manages client sessions bound to a target agent, distinguishing CLI, TUI, MCP, API, and internal callers. Each session has its own ID so that job and consumer results can be isolated per client.
Mark the caller with --source, then use list, status, and close to follow session lifecycle - useful when multiple clients are running diagnostics concurrently against the same target.
Syntax
peeka-cli client <subcommand> [options]
Subcommands
| Subcommand | Description |
|---|---|
create --target <id> --source <source> |
Create a client session |
list [--target <id>] |
List client sessions, optionally filtered by target |
status --client <id> |
Show client session status |
close --client <id> |
Close a client session |
--source can be cli, tui, mcp, api, or internal. create also accepts --user <id> for an optional user identifier.
All subcommands support --format table (default) or --format json.
Examples
# Create a client for CLI automation
peeka-cli client create --target target_abcd1234 --source cli --format json
# List clients for one target
peeka-cli client list --target target_abcd1234
# Inspect and close a client
peeka-cli client status --client client_123
peeka-cli client close --client client_123
Typical Uses
- Give each caller a distinct identity when multiple tools connect to the same target.
- Associate job, probe, consumer, or dx operations with a specific client.
- Create a client first and pass
--clientwhen automation needs explicit ownership or access control.
Version History
| Version | Release Date | Changes |
|---|---|---|
| 0.1.16 | 2026-06-07 | Added the client command group |