Add accurate CLI output format showcase documentation #4501

New issue

Open

opened 2026-04-08 13:53:25 +00:00 by HAL9000 · 1 comment

HAL9000 commented

2026-04-08 13:53:25 +00:00

Owner

Summary

Add an output-format showcase example for the CleverAgents CLI
Ensure documented JSON/YAML envelopes match the live format_output behavior (empty command field, default message text "ok")
Clarify how actor list handles its --format flag versus the global flag
Update docs/showcase/examples.json without dropping existing showcase entries

Motivation

The developer documentation is missing a verified walkthrough for the CLI output format flags and the existing draft contains inaccuracies that contradict the live CLI behavior. Without corrections, readers can lose context on existing showcases and reproduce incorrect envelope structures.

Acceptance Criteria

Showcase covers version, info, diagnostics, and actor list across all supported formats
Envelope examples mirror the runtime behavior (blank command when not set, message text ok)
Documentation instructs users to use the per-command --format flag for actor list
docs/showcase/examples.json retains existing entries and records the new example

Automated by CleverAgents Bot
Supervisor: Implementation | Agent: implementation-worker

## Summary - [ ] Add an output-format showcase example for the CleverAgents CLI - [ ] Ensure documented JSON/YAML envelopes match the live `format_output` behavior (empty `command` field, default message text "ok") - [ ] Clarify how `actor list` handles its `--format` flag versus the global flag - [ ] Update `docs/showcase/examples.json` without dropping existing showcase entries ## Motivation The developer documentation is missing a verified walkthrough for the CLI output format flags and the existing draft contains inaccuracies that contradict the live CLI behavior. Without corrections, readers can lose context on existing showcases and reproduce incorrect envelope structures. ## Acceptance Criteria - Showcase covers `version`, `info`, `diagnostics`, and `actor list` across all supported formats - Envelope examples mirror the runtime behavior (blank `command` when not set, message text `ok`) - Documentation instructs users to use the per-command `--format` flag for `actor list` - `docs/showcase/examples.json` retains existing entries and records the new example --- **Automated by CleverAgents Bot** Supervisor: Implementation | Agent: implementation-worker

~~HAL9000 referenced this issue 2026-04-08 13:54:06 +00:00~~

docs: add showcase example for output format flags (json/yaml/plain/table/color/rich) #4209

~~HAL9000 referenced this issue 2026-04-08 13:54:34 +00:00~~

docs: add showcase example for output format flags (json/yaml/plain/table/color/rich) #4209

HAL9000 commented

2026-04-08 14:16:47 +00:00

Author

Owner

MoSCoW classification: Could Have

Rationale: CLI output format showcase documentation is supplementary. The CLI output formatting functionality itself is what matters — showcase docs improve user experience but are not required for any milestone's acceptance criteria. This is documentation polish. Could Have.

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner

MoSCoW classification: **Could Have** Rationale: CLI output format showcase documentation is supplementary. The CLI output formatting functionality itself is what matters — showcase docs improve user experience but are not required for any milestone's acceptance criteria. This is documentation polish. Could Have. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner

HAL9000 added the

labels

2026-04-09 01:20:15 +00:00