weatherreporter/docs/cli.md

Weatherreporter CLI

weatherreporter generate daily, weatherreporter generate tomorrow, weatherreporter generate three-day, weatherreporter run evening, and the Sunday weatherreporter run morning path currently write Markdown reports through scriptorium, after writing managed preparation artifacts and running scriptorium render as a preflight check. Unsupported 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.md

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

For tomorrow planning:

weatherreporter generate tomorrow --out ./tomorrow.md
weatherreporter run evening

For the 3-Day Outlook:

weatherreporter generate three-day --out ./three-day.md

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, generate tomorrow, and generate three-day write a briefing snapshot, prompt input data package, render preflight output, Markdown report, and metadata file under the configured workspace. run evening generates the Tomorrow Planning Brief. run morning can generate Daily Today and the 3-Day Outlook when the resolved batch contains only implemented report types; when Weekend Outlook is part of the resolved batch, execution stops at the current not-implemented boundary. Other generate commands resolve one report request and stop before report generation.

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 Markdown report copy for generate daily, generate tomorrow, and generate three-day; 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.