2026-05-29 16:52:02 +00:00
# Weatherreporter CLI
2026-05-29 18:08:50 +00:00
`weatherreporter generate daily` , `weatherreporter generate tomorrow` ,
2026-05-29 18:16:10 +00:00
`weatherreporter generate three-day` , `weatherreporter generate weekend` ,
`weatherreporter run morning` , and `weatherreporter run evening` currently
write Markdown reports through `scriptorium` , after writing managed preparation
artifacts and running `scriptorium render` as a preflight check. Unsupported
report generation still resolves configuration, report definitions, and valid
periods, then returns a not-implemented error.
2026-05-29 16:52:02 +00:00
## Shortest Useful Command
```sh
2026-05-29 17:47:42 +00:00
weatherreporter generate daily --date 2026-05-29 --out ./daily.md
2026-05-29 16:52:02 +00:00
```
2026-05-29 17:23:49 +00:00
The command parses flags, loads configuration, fetches weather data, builds a
2026-05-29 17:47:42 +00:00
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.
2026-05-29 16:58:18 +00:00
2026-05-29 18:00:27 +00:00
For tomorrow planning:
```sh
weatherreporter generate tomorrow --out ./tomorrow.md
weatherreporter run evening
```
2026-05-29 18:08:50 +00:00
For the 3-Day Outlook:
```sh
weatherreporter generate three-day --out ./three-day.md
2026-05-29 18:16:10 +00:00
weatherreporter generate weekend --out ./weekend.md
2026-05-29 18:08:50 +00:00
```
2026-05-29 16:52:02 +00:00
## Command Overview
```text
2026-05-29 16:58:18 +00:00
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
2026-05-29 16:52:02 +00:00
```
2026-05-29 18:16:10 +00:00
`generate daily` , `generate tomorrow` , `generate three-day` , and
`generate weekend` 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`
generates Daily Today and the 3-Day Outlook, plus Weekend Outlook except on
2026-05-29 18:20:39 +00:00
Sunday. Run commands continue remaining reports after an independent report
failure, print a JSON aggregate summary to stdout, write compact report status
logs to stderr, and return nonzero when any report failed. Other `generate`
commands resolve one report request and stop before report generation.
2026-05-29 16:52:02 +00:00
## Flags
- `-h` , `--help` : show help.
2026-05-29 16:58:18 +00:00
- `--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.
2026-05-29 18:16:10 +00:00
- `--out PATH` : optional Markdown report copy for `generate daily` , `generate tomorrow` , `generate three-day` , and `generate weekend` ; reserved for later generated report output on other `generate` commands.
2026-05-29 18:20:39 +00:00
- `--out-dir PATH` : optional directory for extra Markdown report copies from `run morning` and `run evening` .
2026-05-29 16:58:18 +00:00
- `--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.