cleveragents/cleveragents-core

Fork 3

UAT: `agents version`, `agents info`, and `agents diagnostics` `--format` option help text missing `color` and `table` formats — spec requires all 6 formats #2575

New issue

Open

opened 2026-04-03 18:58:01 +00:00 by freemo · 1 comment

freemo commented

2026-04-03 18:58:01 +00:00

Owner

Metadata

Branch: fix/cli-format-help-text
Commit Message: fix(cli): add color and table to --format help text for version/info/diagnostics
Milestone: v3.7.0
Parent Epic: #868

Background and Context

The spec (docs/specification.md, Global Options section) defines the --format option as accepting rich|color|table|plain|json|yaml — 6 formats. However, the --format option on the version, info, and diagnostics commands in src/cleveragents/cli/main.py only lists 4 formats in their help text, omitting color and table.

While format_output() in formatting.py does support color and table functionally, the help text is incomplete and users have no way to discover these options from the CLI help.

Current Behavior

The --format help text on three commands reads:

# In main.py, version command (line ~317):
help="Output format: rich, plain, json, yaml",

# In main.py, info command (line ~340):
help="Output format: rich, plain, json, yaml",

# In main.py, diagnostics command (line ~365):
help="Output format: rich, plain, json, yaml",

Running any of the following shows only 4 formats:

agents version --help
agents info --help
agents diagnostics --help

Output shows: --format [rich|plain|json|yaml] — color and table are absent.

Expected Behavior

Per docs/specification.md (Global Options), --format must accept all 6 formats:

--format (rich|color|table|plain|json|yaml)

All three commands (version, info, diagnostics) should document the full format set in their help text:

help="Output format: rich, color, table, plain, json, yaml",

Acceptance Criteria

agents version --help shows all 6 formats: rich, color, table, plain, json, yaml
agents info --help shows all 6 formats: rich, color, table, plain, json, yaml
agents diagnostics --help shows all 6 formats: rich, color, table, plain, json, yaml
The --format option choices/enum (if constrained) also includes color and table
No functional regression — all 6 formats continue to work as before

Supporting Information

Code location: src/cleveragents/cli/main.py lines ~317, ~340, ~365
Spec reference: docs/specification.md — Global Options section: --format (rich|color|table|plain|json|yaml)
Functional support confirmed: format_output() in formatting.py already handles color and table; this is a documentation/help-text-only fix

Subtasks

Locate the three --format option definitions in src/cleveragents/cli/main.py (~lines 317, 340, 365)
Update version command --format help text to list all 6 formats: rich, color, table, plain, json, yaml
Update info command --format help text to list all 6 formats: rich, color, table, plain, json, yaml
Update diagnostics command --format help text to list all 6 formats: rich, color, table, plain, json, yaml
Verify the option's type=click.Choice([...]) (if present) also includes color and table
Tests (Behave/pytest): Add or update scenarios verifying --help output lists all 6 formats for each command
Verify coverage >= 97% via nox -s coverage_report
Run nox (all default sessions), fix any errors

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
All nox stages pass.
Coverage >= 97%.

Automated by CleverAgents Bot
Supervisor: UAT Testing | Agent: ca-new-issue-creator

## Metadata - **Branch**: `fix/cli-format-help-text` - **Commit Message**: `fix(cli): add color and table to --format help text for version/info/diagnostics` - **Milestone**: v3.7.0 - **Parent Epic**: #868 ## Background and Context The spec (`docs/specification.md`, Global Options section) defines the `--format` option as accepting `rich|color|table|plain|json|yaml` — 6 formats. However, the `--format` option on the `version`, `info`, and `diagnostics` commands in `src/cleveragents/cli/main.py` only lists 4 formats in their help text, omitting `color` and `table`. While `format_output()` in `formatting.py` does support `color` and `table` functionally, the help text is incomplete and users have no way to discover these options from the CLI help. ## Current Behavior The `--format` help text on three commands reads: ```python # In main.py, version command (line ~317): help="Output format: rich, plain, json, yaml", # In main.py, info command (line ~340): help="Output format: rich, plain, json, yaml", # In main.py, diagnostics command (line ~365): help="Output format: rich, plain, json, yaml", ``` Running any of the following shows only 4 formats: ```bash agents version --help agents info --help agents diagnostics --help ``` Output shows: `--format [rich|plain|json|yaml]` — `color` and `table` are absent. ## Expected Behavior Per `docs/specification.md` (Global Options), `--format` must accept all 6 formats: ``` --format (rich|color|table|plain|json|yaml) ``` All three commands (`version`, `info`, `diagnostics`) should document the full format set in their help text: ```python help="Output format: rich, color, table, plain, json, yaml", ``` ## Acceptance Criteria - [ ] `agents version --help` shows all 6 formats: `rich, color, table, plain, json, yaml` - [ ] `agents info --help` shows all 6 formats: `rich, color, table, plain, json, yaml` - [ ] `agents diagnostics --help` shows all 6 formats: `rich, color, table, plain, json, yaml` - [ ] The `--format` option choices/enum (if constrained) also includes `color` and `table` - [ ] No functional regression — all 6 formats continue to work as before ## Supporting Information - **Code location**: `src/cleveragents/cli/main.py` lines ~317, ~340, ~365 - **Spec reference**: `docs/specification.md` — Global Options section: `--format (rich|color|table|plain|json|yaml)` - **Functional support confirmed**: `format_output()` in `formatting.py` already handles `color` and `table`; this is a documentation/help-text-only fix ## Subtasks - [ ] Locate the three `--format` option definitions in `src/cleveragents/cli/main.py` (~lines 317, 340, 365) - [ ] Update `version` command `--format` help text to list all 6 formats: `rich, color, table, plain, json, yaml` - [ ] Update `info` command `--format` help text to list all 6 formats: `rich, color, table, plain, json, yaml` - [ ] Update `diagnostics` command `--format` help text to list all 6 formats: `rich, color, table, plain, json, yaml` - [ ] Verify the option's `type=click.Choice([...])` (if present) also includes `color` and `table` - [ ] Tests (Behave/pytest): Add or update scenarios verifying `--help` output lists all 6 formats for each command - [ ] Verify coverage >= 97% via `nox -s coverage_report` - [ ] Run `nox` (all default sessions), fix any errors ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done. - All nox stages pass. - Coverage >= 97%. --- **Automated by CleverAgents Bot** Supervisor: UAT Testing | Agent: ca-new-issue-creator

freemo added this to the v3.7.0 milestone

2026-04-03 18:58:15 +00:00

freemo added a new dependency

2026-04-03 18:59:57 +00:00

#868 Epic: TUI Interface, Modals and Persona System

freemo referenced this issue

2026-04-03 19:00:56 +00:00

Task: Autonomous build progress report — v3.7.0 Production Push — 2026-04-03 #2436

freemo commented

2026-04-03 19:02:14 +00:00

Author

Owner

Issue triaged by project owner:

State: Verified
MoSCoW: Should Have

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

Issue triaged by project owner: - **State**: Verified - **MoSCoW**: Should Have --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: ca-project-owner

freemo referenced this issue

2026-04-03 19:03:52 +00:00

[UAT-SUPERVISOR] Progress Report — Cycle 1591 — v3.7.0 #2593

freemo added a new dependency

2026-04-03 19:08:53 +00:00

#2597 fix(ci): restore all CI quality gates to passing on master — no suppression, no bypasses

freemo referenced this issue

2026-04-03 19:14:03 +00:00

[UAT-SUPERVISOR] Progress Report — Cycle 1601 — v3.7.0 #2603

freemo referenced this issue

2026-04-03 19:24:12 +00:00

[UAT-SUPERVISOR] Progress Report — Cycle 1611 — v3.7.0 #2605