2026-05-29 11:22:44 +00:00
|
|
|
# weatherreporter
|
2026-05-29 11:16:17 +00:00
|
|
|
|
2026-08-01 20:11:57 +00:00
|
|
|
Weatherreporter is a Go CLI that turns normalized weather data into
|
2026-07-31 01:00:21 +00:00
|
|
|
human-facing Markdown reports.
|
|
|
|
|
|
2026-08-01 20:11:57 +00:00
|
|
|
It produces a Markdown report at an operator-owned destination and can upload
|
2026-08-02 06:10:15 +00:00
|
|
|
the completed output through Distributor. It can also compare explicitly
|
|
|
|
|
selected Promptkit profiles against one shared prepared report and publish a
|
|
|
|
|
local comparison bundle.
|
2026-05-29 16:52:02 +00:00
|
|
|
|
|
|
|
|
## Quickstart
|
|
|
|
|
|
|
|
|
|
```sh
|
2026-08-01 20:11:57 +00:00
|
|
|
weatherreporter generate today
|
2026-05-29 16:52:02 +00:00
|
|
|
```
|
|
|
|
|
|
2026-07-31 01:00:21 +00:00
|
|
|
Configure a Weather API endpoint first; see the
|
2026-08-01 20:11:57 +00:00
|
|
|
[configuration reference](docs/config.md). The report is written to
|
2026-08-02 01:41:03 +00:00
|
|
|
`today.md` in the current directory when `output.directory` is not configured.
|
|
|
|
|
Set that configuration value for an ordinary publication directory, or use
|
|
|
|
|
`--out` for one command. See the [CLI reference](docs/cli.md) and [operations
|
|
|
|
|
guide](docs/operations.md) for command and operating details.
|
2026-07-31 01:00:21 +00:00
|
|
|
|
2026-05-29 16:52:02 +00:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
- [CLI reference](docs/cli.md)
|
2026-05-29 16:58:18 +00:00
|
|
|
- [Configuration reference](docs/config.md)
|
2026-05-29 17:40:38 +00:00
|
|
|
- [Operations guide](docs/operations.md)
|
2026-08-02 06:10:15 +00:00
|
|
|
- [Comparison bundle contract](docs/integrations/comparison-bundle.md)
|
2026-07-31 00:50:48 +00:00
|
|
|
- [Development guide](docs/development.md)
|
2026-07-31 01:00:21 +00:00
|
|
|
- [Architecture policy](docs/policy/architecture.md)
|
