docs: add showcase example for CLI version/info/diagnostics basics #11108
Merged
HAL9000
merged 3 commits from 2026-06-15 04:14:35 +00:00
fix-pr-4211 into master
Labels
Clear labels
auto/needs-reevaluation
controller-managed
overdue
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Needs Feedback
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.
Currently being processed by an implementer worker.
Currently being processed by the merge driver.
Currently being processed by a reviewer worker.
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.
Tracking issues used by the AI Automation system for agents to communicate and report.
Rebase conflict needs LLM conflict-resolver.
Failing CI needs implementer attention.
Documenting a driver incident or rollback.
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.
A ticket in a blocked state and unable to complete until some other task is completed first.
Bounty
$100
A bounty of $100 for any open-source contributor who provides a MR that solves this issue
Bounty
$1000
A bounty of $1000 for any open-source contributor who provides a MR that solves this issue
Bounty
$10000
A bounty of $10000 for any open-source contributor who provides a MR that solves this issue
Bounty
$20
A bounty of $20 for any open-source contributor who provides a MR that solves this issue
Bounty
$2000
A bounty of $2000 for any open-source contributor who provides a MR that solves this issue
Bounty
$250
A bounty of $250 for any open-source contributor who provides a MR that solves this issue
Bounty
$50
A bounty of $50 for any open-source contributor who provides a MR that solves this issue
Bounty
$500
A bounty of $500 for any open-source contributor who provides a MR that solves this issue
Bounty
$5000
A bounty of $5000 for any open-source contributor who provides a MR that solves this issue
Bounty
$750
A bounty of $750 for any open-source contributor who provides a MR that solves this issue
MoSCoW
Could have
Could have feature in order to satisfy the epic/legendary.
MoSCoW
Must have
Must have feature in order to satisfy the epic/legendary.
MoSCoW
Should have
Should have feature in order to satisfy the epic/legendary.
There are questions in the ticket that can not be completed until the project owner provides clarity.
Points
1
1 man-hours worth of work for an expert with no learning curve.
Points
13
13 man-hours worth of work for an expert with no learning curve.
Points
2
2 man-hours worth of work for an expert with no learning curve.
Points
21
21 man-hours worth of work for an expert with no learning curve.
Points
3
3 man-hours worth of work for an expert with no learning curve.
Points
34
34 man-hours worth of work for an expert with no learning curve.
Points
5
5 man-hours worth of work for an expert with no learning curve.
Points
55
55 man-hours worth of work for an expert with no learning curve.
Points
8
8 man-hours worth of work for an expert with no learning curve.
Points
88
88 man-hours worth of work for an expert with no learning curve.
Priority
Backlog
This ticket has backlogged priority and is not to be worked on yet
Priority
CI Blocker
Critical priority issue that blocks CI/CD pipeline and prevents PR merges
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
A ticket for learning a tool or technology that is needed to be able to do future planning and design.
State
Completed
The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.
State
Duplicate
A ticket that represents the same content as an existing ticket.
State
In Progress
A ticket that is actively being developed.
State
In Review
A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.
State
Paused
This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.
State
Unverified
All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.
State
Verified
The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.
State
Wont Do
This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.
Type
Automation
Any edits or discussion about the AI automated coding system.
Type
Bug
Something that doesnt work as intended.
Type
Discussion
Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.
Type
Documentation
An error or improvement needed in the documentation.
Type
Epic
Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.
Type
Feature
Some new functionality not present.
Type
Legendary
A type of Epic which will contain other Epics.
Type
Refactor
A code change that restructures existing code without changing its external behavior.
Type
Support
Someone needs help using the project.
Type
Task
A generic task that doesnt fit into the other type categories.
Type
Testing
Work exclusively focusing on fixing or expanding testing.
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
aditya (Aditya Chhabra)
aleenaumair (Aleena Umair)
brent.edwards (Brent Edwards)
CoreRasurae (Luis Mendes)
drew (Drew Morris)
eugen.thaci (Eugen Thaci)
freemo (Jeffrey Phillips Freeman)
HAL9000 (HAL 9000)
HAL9001 (HAL9001)
hamza.khyari (Hamza Khyari)
hurui200320 (Rui Hu)
justin.morris
khird (Kyle Hird)
org.cleveragents
Clear assignees
aditya (Aditya Chhabra)
aleenaumair (Aleena Umair)
brent.edwards (Brent Edwards)
CoreRasurae (Luis Mendes)
drew (Drew Morris)
eugen.thaci (Eugen Thaci)
freemo (Jeffrey Phillips Freeman)
HAL9000 (HAL 9000)
HAL9001 (HAL9001)
hamza.khyari (Hamza Khyari)
hurui200320 (Rui Hu)
justin.morris
khird (Kyle Hird)
org.cleveragents
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: cleveragents/cleveragents-core#11108
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "fix-pr-4211"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Add a verified CLI showcase entry for the
version,info, anddiagnosticsintrospection commands, update CHANGELOG.md/CONTRIBUTORS.md, and fix an inaccurate fast-path claim in the documentation.Changes (2 commits):
1. docs: add showcase example for CLI version/info/diagnostics basics
docs/showcase/examples.jsonfor the CLI version/info/diagnostics guide2. docs: fix inaccurate fast-path claim in CLI basics documentation
version,info, anddiagnosticscommands are on the fast-path--helpand--versionuse fast-path eager exit; the three introspection commands are lightweight but do not benefit from the optimizationFiles changed:
**ISSUES CLOSED: #7592
Review Summary
This PR adds a showcase example for the CLI
version,info, anddiagnosticscommands and fixes an inaccurate fast-path claim in the documentation. The documentation content itself is accurate, well-written, and the fast-path correction is correct. However, there are five blocking issues that must be resolved before this PR can be merged.CI Gate Status (required-for-merge checks)
linttypechecksecurityunit_testscoverageThe five required-for-merge CI checks all pass. However, two other CI jobs are failing (see blockers below).
Failing CI Jobs
e2e_testsbenchmark-regressionstatus-check(gate)BLOCKING Issues
1. CI failures:
e2e_testsandbenchmark-regressionare failing.Per CONTRIBUTING.md, all CI jobs must pass before a PR can be merged.
status-checkis the merge gate aggregator and currently reports failure. Investigate whether these failures are pre-existing or introduced by this branch. Either fix them or document clearly that they are pre-existing infrastructure failures unrelated to this PR and request maintainer override.2. Two commits for one issue - violates the one-issue-one-commit atomicity rule.
CONTRIBUTING.md requires each issue to map to exactly one commit. This PR has two commits that both close #7592:
fee708e0: docs: add showcase example for CLI version/info/diagnostics basicsec0dded4: docs: fix inaccurate fast-path claim in CLI basics documentationThe second commit is a correction to the first. Per project policy, history must be cleaned up before merging using interactive rebase to squash fixup commits. These two commits must be squashed into a single atomic commit.
3. Branch name does not follow naming conventions.
The branch is
fix-pr-4211. Per CONTRIBUTING.md, documentation-only changes must use thefeature/mN-<descriptive-name>prefix, where N is the milestone number. Issue #7592 is in milestone v3.6.0, so the branch should be namedfeature/m6-<descriptive-name>(e.g. feature/m6-showcase-cli-basics). The fix-pr- prefix is not a recognized convention and the milestone number is absent entirely. Note: if renaming is not possible after the PR is open, document the deviation in the PR body.4. PR has no milestone assigned.
CONTRIBUTING.md requires the PR to be assigned to the same milestone as the linked issue. Issue #7592 is in milestone v3.6.0. Please assign milestone v3.6.0 to this PR.
5. PR has no Type/ label.
CONTRIBUTING.md requires exactly one Type/ label on every PR. This PR should have Type/Documentation applied.
Non-Blocking Suggestions
S1. PR body closing keyword format.
The PR body ends with
**ISSUES CLOSED: #7592(bolded, no Forgejo closing syntax). While the commit footers correctly useISSUES CLOSED: #7592, the PR body should also use Forgejo closing keyword syntax (Closes #7592 or Fixes #7592) to trigger automatic issue close on merge.S2. CHANGELOG entry references old PR number.
The CHANGELOG entry refers to (#4211) (the previous PR number) rather than this PR (#11108). This should be updated to reference the correct PR number so the changelog correctly links to the merged PR.
Acceptance Criteria Check (Issue #7592)
ec0dded4: only --help and --version are fast-path; version, info, diagnostics correctly described as lightweight but not fast-pathContent Quality Assessment
The documentation itself is high quality: the showcase walkthrough is clear, accurate, and beginner-friendly. All command examples include actual output and explanations. The scripting example is practical and correct. The format flag table is comprehensive and accurate. The diagnostics --check CI-friendly usage is well-documented. Once the blocking process issues are resolved, the documentation content itself is approvable.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
Suggestion: CHANGELOG entry references the old PR number #4211 instead of the current PR #11108.
This line reads: - CLI showcase: version/info/diagnostics basics (#4211):
This PR is #11108. The reference to #4211 appears to be a carry-over from a previous attempt at this work. Please update to reference #11108 so the changelog correctly links to the merged PR.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
BLOCKING: Pre-existing conflict marker present in this file.
Line 20 contains a
<<<<<<< HEADmerge conflict marker. While this marker originates from a prior merge on the base branch (it was present before this PR), this PR adds new content to CONTRIBUTORS.md on top of a file that already contains an unresolved conflict marker. Merging this PR would perpetuate the corrupted state.The correct fix is:
This must be resolved before merge.
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
Automated by CleverAgents Bot
Supervisor: PR Review | Agent: pr-review-worker
[CONTROLLER-DEFER:Gate 1:full_duplicate]
This PR has been deferred for re-evaluation. The controller has stepped back
from processing it. To resume, a human or scope-evaluator must clear the
deferral flag AND re-add the auto/sentinel label.
Decision:
To clear the deferral (SQL):
UPDATE workflows SET deferred_reason=NULL,
deferred_at=NULL,
deferred_target_workflow_id=NULL
WHERE workflow_id = 483;
Audit ID: 160746
Automated by the CleverAgents controller pipeline.
Identity: HAL9000 (pipeline action)
📋 Estimate: tier 0.
Documentation-only PR: adds a showcase JSON entry, updates CHANGELOG and CONTRIBUTORS, and corrects a fast-path claim in a markdown file. 5 files, +31/-6, no code logic, no test modifications. CI failures (Robot Framework actor-name errors in integration_tests, downstream coverage/docker/status-check) are clearly unrelated to the documentation content and are consistent with the project's known stale-head rebase conflict pattern. Work reduces to: rebase onto master → CI should pass. Mechanical in scope; tier 0 with medium confidence because the unit_tests log is truncated and the stale-head assumption can't be verified without a rebase.
(attempt #4, tier 1)
🔧 Implementer attempt —
blocked.Blockers:
fee708e0+ec0dded4) into one atomic commit per issue #7592. This requiresgit rebase -i, which is forbidden by the implementer git contract (line: "DO NOT run git rebase (any form)"). The git contract explicitly forbids amend/rebase/reset operations that rewrite history.(attempt #5, tier 1)
🔧 Implementer attempt —
blocked.Files touched:
src/cleveragents/cli/commands/actor_run.py,src/cleveragents/cli/commands/actor.py.Blockers:
fee708e0andec0dded4into one atomic commit for issue #7592. This requiresgit rebase -i, which is explicitly forbidden by the implementer git contract ("DO NOT run git rebase (any form)"). No non-rebase path to squash history exists within allowed operations.0977388b44tof3408b4b3f(attempt #8, tier 2)
🔧 Implementer attempt —
ci-not-ready.🔴 Changes requested
Confidence: high.
Blocking issues (2):
CHANGELOG.md:506-506— CHANGELOG.md line 506:- **CLI showcase: version/info/diagnostics basics (#4211)**: Added a verified CLI showcase example. The PR reference#4211is incorrect — this PR is #11108. All surrounding CONTRIBUTORS.md entries reference PRs numbered 8178–9824+, confirming the repository's current numbering is well above 4211. Merging with this wrong reference makes the entry permanently untraceable in Git/Forgejo history.(#4211)with(#11108)on line 506.CONTRIBUTORS.md:59-59— CONTRIBUTORS.md line 59:* HAL 9000 has contributed CLI documentation for version, info, and diagnostics commands (PR #4211 / issue #7592). The PR reference#4211is incorrect — this PR is #11108. Adjacent entries reference PRs #8178, #8188, #8255, #8258, #8660, #9824 — all consistent with the repo's high numbering. A permanently wrong PR number in CONTRIBUTORS.md breaks traceability back to the actual change.PR #4211withPR #11108on line 59.f3408b4b3ftoc9ad5bcb1c✅ Approved
Reviewed at commit
c9ad5bc.Confidence: high.
Claimed by
merge_drive.py(pid 2329255) until2026-06-15T05:27:36.961336+00:00.This claim is advisory and will be released when the cycle ends, or after the TTL by a sibling driver's expired-claim sweep.
c9ad5bcb1cto61acc6fff5Approved by the controller reviewer stage (workflow 483).