Skip to content

docs(cli): document oneshot usage reports - #59901

Open
r266-tech wants to merge 1 commit into
NousResearch:mainfrom
r266-tech:r266/docs-oneshot-usage-file
Open

docs(cli): document oneshot usage reports#59901
r266-tech wants to merge 1 commit into
NousResearch:mainfrom
r266-tech:r266/docs-oneshot-usage-file

Conversation

@r266-tech

Copy link
Copy Markdown
Contributor

Summary

Document hermes -z --usage-file <path> in the CLI guide and zh-Hans mirror.

This flag was added for one-shot automation so batch callers can capture JSON usage data without scraping terminal output. The new docs show the command and summarize the report fields: estimated cost, token counts, model/provider, API call count, and completion/failure status.

Checks

  • Source-checked hermes_cli/_parser.py and hermes_cli/oneshot.py
  • Docs-only change

@alt-glitch alt-glitch added type/docs Documentation improvements comp/cli CLI entry point, hermes_cli/, setup wizard P3 Low — cosmetic, nice to have labels Jul 7, 2026
@teknium1 teknium1 added sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users area/usage-cost Token accounting, usage reporting, billing, cost tracking labels Jul 15, 2026

@GottZ GottZ left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was generated by AI during triage.

Summary

Two PRs address the same one-shot usage-report feature: #59615 implements the --usage-file JSON reporting path, while #59901 documents that behavior in the English CLI guide and its zh-Hans mirror.

Related pull requests

  • #59615 [merged] related — (+133/-0) — merged reference implementation: adds --usage-file, threads it through both one-shot dispatch paths, writes best-effort JSON reports on success and failure, and adds focused tests. It remains relevant because #59901 documents this merged behavior.
  • #59901 related — (+9/-3) — merge: documents the implemented hermes -z --usage-file <path> workflow and its report fields in both the English CLI guide and zh-Hans mirror, without changing runtime behavior.

Suggested consolidation

Merge #59901 as the documentation follow-up to the already merged implementation in #59615; the PRs are complementary, so neither should be closed as a duplicate.

Cross-PR triage: Reviewed 2 pull requests and 0 issues in this complex. Each diff was read against this issue; Assessment working set: 12 kB of PR diffs, 2 kB of issue/PR text, 0 verify verdicts. verdicts reflect diff content, not PR titles. Part of an automated triage batch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/usage-cost Token accounting, usage reporting, billing, cost tracking comp/cli CLI entry point, hermes_cli/, setup wizard P3 Low — cosmetic, nice to have sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants