diff --git a/CHANGELOG.md b/CHANGELOG.md index 18470c7cf..facc2856b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -192,6 +192,12 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ### Added +- **CLI showcase: version/info/diagnostics basics (#4211)**: Added a verified CLI showcase example + for the `version`, `info`, and `diagnostics` introspection commands. The guide walks through + fast-path eager flag behavior (`--help`, `--version`), rich format output with Rich panels, + machine-readable JSON envelope structure shared across all CLI commands, and CI-friendly + `diagnostics --check` health monitoring. Registered in `docs/showcase/examples.json`. Closes #7592. + - `agents actor context clear` command to reset actor message history and state while preserving the underlying context directory via `ContextManager` (#6370). diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 9d040f20b..b059ce6b3 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -28,6 +28,8 @@ Below are some of the specific details of various contributions. * HAL 9000 has contributed the file edit encoding parameter fix (PR #8258 / issue #7559). * HAL 9000 has contributed the architecture-pool-supervisor milestone assignment feature (PR #8188 / issue #7521): added `forgejo_update_pull_request` permission and documented the PR workflow for major spec changes, enabling automatic milestone assignment for specification PRs. * HAL 9000 has contributed the git worktree TOCTOU race condition fix (PR #8178 / issue #7507): replaced the unsafe mkdtemp() + rmdir() pattern with a parent-directory approach to eliminate the race window in concurrent git worktree operations. +* HAL 9000 has contributed CLI documentation for version, info, and diagnostics commands (PR #4211 / issue #7592): created a beginner-friendly showcase walkthrough covering fast-path eager flags, rich format output with Rich panels, machine-readable JSON envelope structure, and CI-friendly diagnostics health checks. + * HAL 9000 has contributed the git_tools TOCTOU race condition fix (PR #8255 / issue #7619): eliminated the Time-Of-Check-To-Time-Of-Use race in `_get_base_env()` by adding double-checked locking with a module-level `threading.Lock`, preventing concurrent threads from writing conflicting environment snapshots. * HAL 9000 has contributed the mandatory PR compliance checklist to `implementation-supervisor.md` (#9824): added an 8-item checklist to the worker prompt body with concrete items covering CHANGELOG.md, CONTRIBUTORS.md, commit footer, CI verification, BDD tests, Epic reference, labels, and milestone assignment to eliminate systemic PR merge blockers. * HAL 9000 has contributed the PlanResult.success derivation fix (PR #8214 / issue #7501): replaced the incorrect `error_message is None` heuristic with a dedicated `result_success` column in the plans table, ensuring plans with historical build errors are not incorrectly marked as failed after a successful apply. diff --git a/docs/showcase/examples.json b/docs/showcase/examples.json index cdd876ca5..ebb589301 100644 --- a/docs/showcase/examples.json +++ b/docs/showcase/examples.json @@ -1,5 +1,26 @@ { "examples": [ + { + "title": "CleverAgents CLI Basics: Version, Info & Diagnostics", + "category": "cli-tools", + "path": "cli-tools/cleveragents-cli-basics.md", + "feature": "CLI version/info/diagnostics basics \u2014 fast-path behavior and output envelope", + "commands": [ + "python -m cleveragents --help", + "python -m cleveragents --version", + "python -m cleveragents version", + "python -m cleveragents --format json version", + "python -m cleveragents info", + "python -m cleveragents --format json info", + "python -m cleveragents diagnostics", + "python -m cleveragents --format json diagnostics", + "python -m cleveragents diagnostics --check" + ], + "complexity": "beginner", + "educational_value": "high", + "generated_by": "uat-tester", + "generated_at": "2026-04-07" + }, { "title": "Mastering Output Format Flags in CleverAgents CLI", "category": "cli-tools", @@ -148,5 +169,5 @@ ] } }, - "last_updated": "2026-04-27" + "last_updated": "2026-05-07" }