Skip to content

fix(miner): cli.js help text is missing the implemented queue dashboard subcommand #5832

Description

@JSONbored

Context

packages/loopover-miner/lib/portfolio-queue-cli.js implements a fully working loopover-miner queue dashboard subcommand (if (subcommand === "dashboard") return runPortfolioDashboard(args, options);, ~line 584), and it's documented as a real, supported command in packages/loopover-miner/README.md ("the same data loopover-miner queue dashboard --json prints locally").

packages/loopover-miner/lib/cli.js's printHelp function lists every other queue subcommand (list, next, claim-batch, metrics, done, release, requeue) in its usage block, but omits queue dashboard entirely — a user running loopover-miner --help or loopover-miner queue --help (or seeing the usage block after a queue parse error) has no way to discover the command from the CLI's own help text, despite it being fully implemented and README-documented.

Requirements

  • Add a loopover-miner queue dashboard [--json]-style line to printHelp's queue usage block in cli.js, matching the format and level of detail of the sibling lines already there (e.g. the one-line description style used for queue metrics).
  • No functional change to runPortfolioDashboard or command dispatch — this is a help-text-only fix.

Deliverables

  • cli.js's printHelp includes a queue dashboard line consistent with the existing queue subcommand list.
  • A regression test (e.g. in test/unit/miner-cli.test.ts, wherever the existing help-text tests for cli.js live) asserting the printed help output contains queue dashboard, so a future added-but-undocumented subcommand regression is caught automatically instead of relying on manual review.

Test Coverage Requirements

packages/loopover-miner/lib/** is in Codecov's coverage.include; the changed line itself is a string literal with no branch, but the new regression test asserting its presence in the printed help output is the required coverage artifact here (a plain diff-line coverage hit on the added string is not sufficient on its own to demonstrate the fix — the test is what proves it).

Expected Outcome

loopover-miner --help (and the queue usage block shown on a queue parse error) lists every implemented queue subcommand, including dashboard — a user can discover the command from the CLI's own help text without having to read the README or source.

Links & Resources

  • packages/loopover-miner/lib/cli.js (printHelp, the queue usage block)
  • packages/loopover-miner/lib/portfolio-queue-cli.js (dashboard subcommand dispatch, ~line 584)
  • packages/loopover-miner/README.md (existing queue dashboard documentation)

Metadata

Metadata

Assignees

No one assigned

    Labels

    gittensor:bugGittensor-scored bug fix — scores a 0.05x multiplier.help wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions