docs: add showcase example for CLI version/info/diagnostics basics #4211

Closed
HAL9000 wants to merge 4 commits from docs/add-showcase-cli-basics into master
4 changed files with 31 additions and 6 deletions
+7 -2
View File
@@ -612,6 +612,12 @@ _ALL_DATA_COLUMNS + ") " "SELECT " + _ALL_DATA_COLUMNS + " FROM v3_plans"`.
not visually distinguished in the `agents plan tree` output. The scenario is tagged
`@tdd_expected_fail` and will pass (by inversion) until the underlying gap described
in Spec Requirement #7 is fixed.
- **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.
- **TDD: MCPToolAdapter.infer_resource_slots() TypeError with null properties** (#10470):
Added a TDD issue-capture Behave scenario that reproduces the bug where
`MCPToolAdapter.infer_resource_slots()` raises `TypeError` when the input schema
@@ -1413,8 +1419,7 @@ iteration` and data corruption under concurrent plan execution. All public
- **Decision Recording**: Every choice point in a plan's lifecycle is recorded as
a persistent `Decision` node in a tree. Decisions capture the question, chosen
option, alternatives considered, confidence score, rationale, actor reasoning,
and a context snapshot for replay. 11 decision types cover all phases of plan
option, alternatives considered, confidence score, rationale, and a context snapshot for replay. 11 decision types cover all phases of plan
execution. See [`docs/reference/decision_model.md`](docs/reference/decision_model.md).
- **Decision Service** (`DecisionService`): Application-layer interface for
+1
View File
@@ -102,3 +102,4 @@ Below are some specific details of individual PR contributions.
* HAL 9000 has contributed advanced context strategies integration tests (#10671, #7574): Behave scenarios with FakeEmbeddings for deterministic testing, Robot Framework E2E tests, and strategy implementation stubs covering semantic search, relevance scoring, adaptive selection, context fusion, YAML configuration, and ContextAssembler integration.
* HAL 9000 has contributed the resource and skill management showcase alignment (#4213): updated the CLI tools showcase with consistent counts, explicit save instructions, metadata callouts, and README framing for platform walkthroughs; removed obsolete tdd_issue tags from coverage threshold Robot tests; hardened the Skip If No LLM Keys E2E helper with per-key regex validation and log suppression to prevent credential leakage.
* HAL 9000 has contributed the sandbox dirs cache invalidation fix (PR #11091 / issue #7527): introduced `SandboxDirsCache` to track filesystem paths of sandbox-created directories by plan_id, wired automatic invalidation into all cleanup/purge methods (`cleanup_all`, `cleanup_abandoned`, `clear_sandbox_dirs_cache`, `_cleanup_on_exit_handler`), and added BDD test coverage.
* 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.
@@ -460,9 +460,7 @@ based on code analysis. Exact values depend on your local environment.*
- **`--format`** is a global flag that must come **before** the subcommand.
- **`diagnostics --check`** is CI-friendly: exits non-zero only when there are
actual `ERROR`-level checks (missing API keys are `WARN`, not `ERROR`).
- All three introspection commands (`version`, `info`, `diagnostics`) are
**lightweight** — they're in the fast-path that avoids loading heavy
subcommand modules.
- Both --help and --version use a fast-path eager exit that avoids loading subcommand modules, resulting in instant response times. The version, info, and diagnostics commands are lightweight introspection tools but do not benefit from the fast-path optimization.
## Try It Yourself
+22 -1
View File
1
@@ -21,6 +21,27 @@
"generated_by": "uat-tester",
Outdated
Review

SUGGESTION (non-blocking): The new entry introduces fields (complexity, educational_value, generated_by, generated_at) that are absent from all 3 existing entries. While the feature field is now consistent, this schema heterogeneity will make it progressively harder to build tooling on top of this index as more entries are added.

Consider one of:

  • (a) Remove the extra fields from the new entry to match the minimal existing schema, OR
  • (b) Backfill complexity, educational_value, generated_by, generated_at on all 4 entries for a uniform schema

This is non-blocking — the content is functionally correct — but worth addressing for long-term maintainability.


Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker

**SUGGESTION (non-blocking):** The new entry introduces fields (`complexity`, `educational_value`, `generated_by`, `generated_at`) that are absent from all 3 existing entries. While the `feature` field is now consistent, this schema heterogeneity will make it progressively harder to build tooling on top of this index as more entries are added. Consider one of: - (a) Remove the extra fields from the new entry to match the minimal existing schema, OR - (b) Backfill `complexity`, `educational_value`, `generated_by`, `generated_at` on all 4 entries for a uniform schema This is non-blocking — the content is functionally correct — but worth addressing for long-term maintainability. --- Automated by CleverAgents Bot Supervisor: PR Review | Agent: pr-review-worker
"generated_at": "2026-04-19"
},
{
"title": "CleverAgents CLI Basics: Version, Info & Diagnostics",
"category": "cli-tools",
"path": "cli-tools/cleveragents-cli-basics.md",
"feature": "CLI version/info/diagnostics basics — 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",
@@ -216,5 +237,5 @@
]
}
},
"last_updated": "2026-04-27"
"last_updated": "2026-05-07"
}