job Command

Table of Contents

  1. Overview
  2. Syntax
  3. Subcommands
  4. Examples
  5. Version History
  6. Related Commands

Overview

The job command manages asynchronous command jobs: view command lifecycle, inspect result metadata, interrupt running jobs, and clean up historical jobs. Long-running observation commands such as watch, trace, monitor, and top are typically executed as jobs in the background, and job is their unified control entry point.

Use list, status, inspect, interrupt, and cleanup to reclaim resources, locate stuck jobs, and filter history across multiple dimensions (target / client / status) without touching the target’s internal state directly.

Syntax

peeka-cli job <subcommand> [options]

Subcommands

Subcommand Description
list List command jobs
status --job <id> Show job status
inspect --job <id> Show full job details
interrupt --job <id> Interrupt a running job
cleanup Clean old jobs
pull --job <id> --consumer <name> Reserved result-pull interface; currently a Phase 5 stub

Common filters and options:

Option Description
--target <id> Filter by or locate the owning target
--client <id> Filter list by client session
--status <status> Filter list by job status
--completed During cleanup, clean completed jobs only
--older-than <duration> During cleanup, clean jobs older than the duration; default 10m
--format table/json Output format, default table

--older-than accepts seconds or durations such as 30s, 10m, or 2h.

Examples

peeka-cli job list --target target_abcd1234
peeka-cli job status --job job_123 --format json
peeka-cli job inspect --job job_123 --target target_abcd1234
peeka-cli job interrupt --job job_123
peeka-cli job cleanup --completed --older-than 30m

Version History

Version Release Date Changes
0.1.16 2026-06-07 Added the job command group

Back to top

Copyright © 2026 Peeka contributors. Distributed under the Apache License 2.0.

This site uses Just the Docs, a documentation theme for Jekyll.