weatherreporter/docs/cli.md

Weatherreporter CLI

weatherreporter generate daily currently writes managed Daily preparation artifacts under the configured workspace and runs scriptorium render as a preflight check. Other report generation and scheduled runs still resolve configuration, report definitions, and valid periods, then return a not-implemented error.

Shortest Useful Command

weatherreporter generate daily --date 2026-05-29 --out ./daily.data_package.json

The command parses flags, loads configuration, fetches weather data, builds a Daily briefing, writes workspace artifacts, and invokes scriptorium render --input data_package=<managed_path> --format json. When --out is supplied, it also writes a copy of the data package to that path.

Command Overview

weatherreporter generate daily
weatherreporter generate tomorrow
weatherreporter generate three-day
weatherreporter generate weekend
weatherreporter generate storm --start 2026-05-29T18:00 --end 2026-05-30T06:00
weatherreporter run morning
weatherreporter run evening

generate daily writes a briefing snapshot, prompt input data package, render preflight output, and metadata file under the configured workspace. Other generate commands resolve one report request and stop before report generation. run commands resolve a scheduled batch request and stop before execution.

Flags

• -h, --help: show help.
• --config PATH: load configuration from PATH instead of /usr/local/etc/weatherreporter/config.yml.
• --units VALUE: override configured Weather API units.
• --tz NAME: override configured Weather API timezone.
• --out PATH: optional extra data package copy for generate daily; reserved for later generated report output on other generate commands.
• --date YYYY-MM-DD: optional date for generate daily; defaults to the current local date in the configured timezone.
• --start TIME: required start time for generate storm.
• --end TIME: required end time for generate storm.

Storm times accept YYYY-MM-DDTHH:MM in the configured timezone or RFC3339 timestamps with explicit offsets.