Skip to content

Epic: Add live input/output examples to all CLI docs #83

Description

@cdot65

Goal

Replace every !!! warning "Example needed" placeholder on every CLI doc page with live, redacted input/output examples (pretty + JSON + YAML where applicable).

Why

Project rule: every command must show a real input and a real output. Currently only 7 pages site-wide satisfy this. The 4 DLP pages flagged most recently (dictionaries, filtering-profiles, patterns, profiles) are part of a wider gap that spans nearly every page under docs/cli/runtime/, docs/cli/redteam/, and docs/cli/model-security/.

Scope

All docs/cli/runtime/*, docs/cli/runtime/dlp/*, docs/cli/redteam/*, and docs/cli/model-security/* pages that contain the Example needed placeholder.

Approach

  • Spec: docs/superpowers/specs/2026-05-25-cli-docs-examples-design.md
  • Plan: docs/superpowers/plans/2026-05-25-cli-docs-examples.md
  • 13 sub-issues, end-to-end per command group. PREP issue blocks the rest; others parallelize across 3 tmux agents.

Format contract

  • List/get commands → pretty + JSON + YAML captures
  • Write ops (create/update/replace/patch/delete) → JSON only
  • Upstream/CLI/SDK defects → !!! bug admonition with tracking-issue link (never fabricate output)
  • Redaction: tenant IDs, UUIDs, real emails, real customer app names, sensitive keyword content

Sub-issues

(populated after creation; see sub-issues panel)

Definition of done

  • All 13 sub-issue PRs merged.
  • grep -r "Example needed" docs/cli/ returns nothing (or only justified !!! bug placeholders).
  • Every newly-discovered CLI/SDK/upstream defect filed as its own issue with bug or upstream-bug label.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationepicTracks a multi-issue initiative

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions