Reports
Review local and CI-generated TCalc reports
Open a report in the browser, produce CI artifacts, or self-host the optional versioned report service.
Share token and recommendation evidence without storing workspace source in the report service.
Before you begin
- A TCalc JSON report using schema version 1.0.0
- A browser, GitHub Actions runner, or Node host
Open a report without uploading it
Use the report viewer on the TCalc home page to open a JSON report. The browser validates schema version 1.0.0 and renders summary totals and recommendation tiers locally. Selecting a file does not send it to the hosted website.
Reports contain aggregates, warnings, paths, and recommendations rather than source file contents. Review file paths before sharing an exported artifact if repository structure itself is sensitive.
Generate reports in GitHub Actions
The repository includes a TCalc report workflow for pull requests and manual runs. It builds the local CLI, creates a Markdown report, a budgeted repo map, and structured model recommendations, then uploads those files as workflow artifacts. Trusted same-repository pull requests can receive a compact summary comment; fork pull requests remain read-only.
pnpm build
pnpm ci:workspace-reportRun the optional report service
- Set TCALC_DASHBOARD_TOKEN to enable authenticated uploads.
- Start the dashboard package after building the Next.js export.
- POST schema-valid JSON to /api/reports with a Bearer token.
- Set TCALC_DATA_DIR, TCALC_DASHBOARD_HOST, and PORT when the defaults do not fit the host.
$env:TCALC_DASHBOARD_TOKEN = "replace-with-a-secret"
pnpm --filter @wma/dashboard build
pnpm --filter @wma/dashboard start