Codumentor logo Codumentor

Console Report Plugin

Prints a formatted Session Report to the terminal at the end of a print-mode (-p) run. It only renders; the numbers come from other plugins.

Enabled in the shipped default config.

Configuration

The plugin itself has no args. Printing is controlled by the top-level flag:

session_report: true   # shipped default; set false to suppress

plugins:
  - module: codumentor.plugins.console_report
    class: ConsoleReportPlugin

session_report is true in the bundled default YAML. The config model default is false if you omit the key from a YAML that does not inherit that default.

Print-mode will not emit a report unless both this plugin and Token Report are loaded (it warns and skips otherwise). Extra sections appear when Telemetry and/or Inference Metrics are also loaded.

Usage

After a codumentor -p … run, the terminal shows a header, one section per contributing plugin, and a footer. Color is used when the terminal supports it.

==================================================
  Session Report
==================================================

  Token Usage
    Model: gpt-4o  Cost: $0.0124
    ...

  Timing Metrics
    Turns: 5
    Wall time: 12.3s
    ...

  Inference Performance
    Avg TTFT: 245ms
    ...
==================================================

Nothing is printed if there are no sections, if session_report is false, or if this plugin is not loaded. The web UI does not show this report.

Notes