Skip to content

Latest commit

 

History

History
102 lines (76 loc) · 4.95 KB

REPORTS.md

File metadata and controls

102 lines (76 loc) · 4.95 KB

Generate and share reports

Reports review your recorded AI work over a chosen period. Your agent examines sessions, identifies recurring patterns, and proposes changes supported by the recordings.

A report includes:

  • Usage: token use, models, and activity over time.
  • Work: recurring tasks, delegation, and opportunities to automate workflows.
  • Health: tool failures, retries, and how sessions recovered.
  • Recommendations: specific changes to skills, instructions, or configuration, with evidence from the sessions that motivated them.

The report is saved as Markdown for you to read and review. You can keep it locally or publish it to HypAware Cloud to share with your organization.

Generate a report

We recommend Fable or Astra for the best report quality.

hyp report generate opens a recorded AI client that has the hypaware-report skill installed, which means Claude Code or Codex, to analyze your local recordings. Tell it which period to cover and what to investigate:

hyp report generate "Cover last week and focus on repeated debugging work"

Without additional instructions, it reviews the previous calendar month.

The report skill drafts ./hypaware-report-<from>-to-<to>/, adding a numbered suffix if needed, and when the report is reviewed runs hyp report save on it, which moves the folder into ~/.hyp/reports ($HYP_HOME/reports). Every finished report is in that one place, and hyp report list shows them beside the published ones (hyp report list --local shows them alone; in JSON, only --local --json lists them, and --json alone lists published reports). The agent never writes under your home directory itself; the CLI does the move, and only a folder that would publish is admitted. The session follows the current directory's recording and sync policy, excerpts it quotes from local-only history included (PRIVACY.md). Publishing remains a separate action, using hyp report publish <name> ....

To get one recommendation instead of a full report, ask for it:

hyp report generate "Give me one recommendation about repeated test failures"

Unless you name a period, the skill uses the 14 days ending yesterday. It writes one recommendation-<slug>.md page in the current directory and does not save a report folder. Publish the page only if you want to share it, with hyp report recommend.

You can also write a Markdown report yourself with your findings, query scope, and tables. The remote renders uploaded Markdown; no local render step is needed.

Publish a report

Publishing makes the report appear in your organization's HypAware Cloud dashboard, where your team can read it.

To share the generated report with your organization, replace REPORT_NAME with the saved name printed by hyp report save (a path to a folder works too) and PERIOD with the reporting period, such as 2026-W36:

hyp report publish REPORT_NAME --kind usage-review --period PERIOD --remote team
hyp report list --kind usage-review --limit 10 --remote team

Publishing uploads the report bundle and requires a write-capable credential. Review the report for private content first. See the report command reference for bundles, downloads, and organization-wide deletion.

To see the recommendations your organization has not acted on yet:

hyp report list --status open

Over MCP, on your team's server at /v1/mcp, use list_recommendations.

To act on a recommendation from inside a repository, run hyp report fix with the id from hyp report list; it starts your agent on the change.

hyp report fix hyprec-0123456789abcdef

Over MCP, the fix_recommendation prompt does the same: the agent reads the recommendation with get_recommendation and marks it applied with set_recommendation_status, the tool for hyp report mark.

If a later report finds the same problem again, a recommendation marked applied goes back to open, with the newer recommendation named as the reason.