Skip to content

report

Which report files are written and where.

Keys

Key Type Default Description
formats list [html, json, svg] Reports that cloudg run, CloudGEngine.run_pipeline() and run_from_reports() write: html, json, svg. run_from_reports() never writes svg. Unknown names are dropped with a warning. cloudg report and cloudg ingest use --format instead.
inline_js bool true Embed Chart.js and D3 in report.html so it works offline; false loads them from cdn.jsdelivr.net (smaller file, needs network access)
output_dir str ./reports Output directory of the CloudGEngine methods called without output_dir, and the MCP workspace root. The CLI commands use -o instead.

In config.yaml

config.yaml (report)
report:
  formats:                 # reports written by cloudg run and CloudGEngine
    - html
    - json
    - svg
  inline_js: true          # embed Chart.js and D3 in report.html so it works offline
                           # (false: load them from cdn.jsdelivr.net)
  output_dir: ./reports    # CloudGEngine and MCP default; the CLI uses -o

Read from the annotated example config.yaml and the CloudGConfig models in cloudg/config.py.