UAT: `_FORMAT_HELP` constant missing `color` format in all entity command files — spec defines 6 valid formats #3562

New issue

Open

opened 2026-04-05 19:44:20 +00:00 by freemo · 1 comment

freemo commented

2026-04-05 19:44:20 +00:00

Owner

Metadata

Branch: fix/cli-format-help-missing-color
Commit Message: fix(cli): add missing color format to _FORMAT_HELP in all entity command files
Milestone: (none — backlog)
Parent Epic: (see orphan note below)

Description

The _FORMAT_HELP constant string used as the help text for --format options across all entity command files omits the color format. The spec defines 6 valid output formats: rich, color, table, plain, json, yaml. However, the _FORMAT_HELP string in the following files only lists 5 formats:

_FORMAT_HELP = "Output format: json, yaml, plain, table, or rich (default: rich)"

Affected files:

/app/src/cleveragents/cli/commands/project.py (line 50)
/app/src/cleveragents/cli/commands/actor.py (line 45)
/app/src/cleveragents/cli/commands/skill.py (line 66)
/app/src/cleveragents/cli/commands/tool.py (line 72)
/app/src/cleveragents/cli/commands/action.py (line 82)
/app/src/cleveragents/cli/commands/validation.py (line 72)
/app/src/cleveragents/cli/commands/resource.py (line 102)

The color format is implemented in OutputFormat enum (formatting.py line 45) and in format_output() (formatting.py line 215), but users cannot discover it from the --help output for any of these commands.

Note: The version, info, and diagnostics commands in main.py also have this issue (their help text says "rich, plain, json, yaml" omitting both color and table), but those are already tracked in separate issues.

Steps to Reproduce

Run agents project list --help
Observe the --format option description: "Output format: json, yaml, plain, table, or rich (default: rich)"
Note that color is missing from the list
However, agents project list --format color works correctly (produces ANSI-colored output)

Expected Behavior

The --format help text should list all 6 valid formats: rich, color, table, plain, json, yaml.

Actual Behavior

The --format help text omits color in all entity command files.

Proposed Fix

Update _FORMAT_HELP in all 7 affected files to:

_FORMAT_HELP = "Output format: rich, color, table, plain, json, or yaml (default: rich)"

Subtasks

Update _FORMAT_HELP in cli/commands/project.py (line 50)
Update _FORMAT_HELP in cli/commands/actor.py (line 45)
Update _FORMAT_HELP in cli/commands/skill.py (line 66)
Update _FORMAT_HELP in cli/commands/tool.py (line 72)
Update _FORMAT_HELP in cli/commands/action.py (line 82)
Update _FORMAT_HELP in cli/commands/validation.py (line 72)
Update _FORMAT_HELP in cli/commands/resource.py (line 102)
Verify agents <entity> list --help output lists all 6 formats for each affected command
Add/update Behave scenario asserting --format color is listed in help text for entity commands
Run nox (all default sessions) and fix any errors

Definition of Done

All 7 _FORMAT_HELP constants updated to include color
--help output for all affected entity commands lists all 6 valid formats
Behave scenario added/updated to assert color appears in --format help text
All nox stages pass
Coverage >= 97%

Backlog note: This issue was discovered during autonomous operation
on milestone v3.7.0. It does not block milestone completion and has been
placed in the backlog for human review and future milestone assignment.

Automated by CleverAgents Bot
Supervisor: UAT Testing | Agent: ca-uat-tester

## Metadata - **Branch**: `fix/cli-format-help-missing-color` - **Commit Message**: `fix(cli): add missing color format to _FORMAT_HELP in all entity command files` - **Milestone**: *(none — backlog)* - **Parent Epic**: *(see orphan note below)* ## Description The `_FORMAT_HELP` constant string used as the help text for `--format` options across all entity command files omits the `color` format. The spec defines 6 valid output formats: `rich`, `color`, `table`, `plain`, `json`, `yaml`. However, the `_FORMAT_HELP` string in the following files only lists 5 formats: ```python _FORMAT_HELP = "Output format: json, yaml, plain, table, or rich (default: rich)" ``` **Affected files:** - `/app/src/cleveragents/cli/commands/project.py` (line 50) - `/app/src/cleveragents/cli/commands/actor.py` (line 45) - `/app/src/cleveragents/cli/commands/skill.py` (line 66) - `/app/src/cleveragents/cli/commands/tool.py` (line 72) - `/app/src/cleveragents/cli/commands/action.py` (line 82) - `/app/src/cleveragents/cli/commands/validation.py` (line 72) - `/app/src/cleveragents/cli/commands/resource.py` (line 102) The `color` format **is** implemented in `OutputFormat` enum (`formatting.py` line 45) and in `format_output()` (`formatting.py` line 215), but users cannot discover it from the `--help` output for any of these commands. > **Note:** The `version`, `info`, and `diagnostics` commands in `main.py` also have this issue (their help text says "rich, plain, json, yaml" omitting both `color` and `table`), but those are already tracked in separate issues. ## Steps to Reproduce 1. Run `agents project list --help` 2. Observe the `--format` option description: `"Output format: json, yaml, plain, table, or rich (default: rich)"` 3. Note that `color` is missing from the list 4. However, `agents project list --format color` works correctly (produces ANSI-colored output) ## Expected Behavior The `--format` help text should list all 6 valid formats: `rich`, `color`, `table`, `plain`, `json`, `yaml`. ## Actual Behavior The `--format` help text omits `color` in all entity command files. ## Proposed Fix Update `_FORMAT_HELP` in all 7 affected files to: ```python _FORMAT_HELP = "Output format: rich, color, table, plain, json, or yaml (default: rich)" ``` ## Subtasks - [ ] Update `_FORMAT_HELP` in `cli/commands/project.py` (line 50) - [ ] Update `_FORMAT_HELP` in `cli/commands/actor.py` (line 45) - [ ] Update `_FORMAT_HELP` in `cli/commands/skill.py` (line 66) - [ ] Update `_FORMAT_HELP` in `cli/commands/tool.py` (line 72) - [ ] Update `_FORMAT_HELP` in `cli/commands/action.py` (line 82) - [ ] Update `_FORMAT_HELP` in `cli/commands/validation.py` (line 72) - [ ] Update `_FORMAT_HELP` in `cli/commands/resource.py` (line 102) - [ ] Verify `agents <entity> list --help` output lists all 6 formats for each affected command - [ ] Add/update Behave scenario asserting `--format color` is listed in help text for entity commands - [ ] Run `nox` (all default sessions) and fix any errors ## Definition of Done - [ ] All 7 `_FORMAT_HELP` constants updated to include `color` - [ ] `--help` output for all affected entity commands lists all 6 valid formats - [ ] Behave scenario added/updated to assert `color` appears in `--format` help text - [ ] All nox stages pass - [ ] Coverage >= 97% > **Backlog note:** This issue was discovered during autonomous operation > on milestone v3.7.0. It does not block milestone completion and has been > placed in the backlog for human review and future milestone assignment. --- **Automated by CleverAgents Bot** Supervisor: UAT Testing | Agent: ca-uat-tester

freemo added the

labels

2026-04-05 19:44:30 +00:00

freemo commented

2026-04-05 19:44:41 +00:00

Author

Owner

⚠️ Orphan Issue — Manual Epic Linking Required

This issue was created by an automated agent and could not be automatically linked to a parent Epic. The closest matching Epic, #364 (Epic: Additional CLI Commands & UX), is closed.

No currently open Epic was found that specifically covers CLI entity command help text / _FORMAT_HELP string corrections.

Action required: A project maintainer should link this issue to an appropriate open Epic (e.g., a future "CLI UX Polish" or "CLI Help Text Corrections" Epic), or create a new Epic to group related CLI help text issues.

Candidate open Epics for consideration:

#3370 — Automation Profile & Safety Profile CLI (covers CLI commands, v3.6.0)
#868 — TUI Interface, Modals and Persona System (covers output rendering, v3.7.0)

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

⚠️ **Orphan Issue — Manual Epic Linking Required** This issue was created by an automated agent and could not be automatically linked to a parent Epic. The closest matching Epic, **#364 (Epic: Additional CLI Commands & UX)**, is **closed**. No currently open Epic was found that specifically covers CLI entity command help text / `_FORMAT_HELP` string corrections. **Action required:** A project maintainer should link this issue to an appropriate open Epic (e.g., a future "CLI UX Polish" or "CLI Help Text Corrections" Epic), or create a new Epic to group related CLI help text issues. Candidate open Epics for consideration: - **#3370** — Automation Profile & Safety Profile CLI (covers CLI commands, v3.6.0) - **#868** — TUI Interface, Modals and Persona System (covers output rendering, v3.7.0) --- **Automated by CleverAgents Bot** Supervisor: UAT Testing | Agent: ca-new-issue-creator

freemo referenced this issue

2026-04-05 19:45:17 +00:00

[Automated] CleverAgents Build Session - 2026-04-05 #3377