weatherreporter/docs/cli.md

Weatherreporter CLI

weatherreporter generate daily currently writes a Daily briefing JSON artifact. 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.md

The command parses flags, loads configuration, fetches weather data, builds a Daily briefing, and writes the JSON artifact to --out.

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 JSON artifact. 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: output path 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.