Add 3-Day Outlook generation
This commit is contained in:
33
docs/cli.md
33
docs/cli.md
@@ -1,11 +1,12 @@
|
||||
# Weatherreporter CLI
|
||||
|
||||
`weatherreporter generate daily`, `weatherreporter generate tomorrow`, and
|
||||
`weatherreporter run evening` currently write Daily-family Markdown reports
|
||||
`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. Other report generation and scheduled
|
||||
runs still resolve configuration, report definitions, and valid periods, then
|
||||
return a not-implemented error.
|
||||
`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
|
||||
|
||||
@@ -27,6 +28,12 @@ weatherreporter generate tomorrow --out ./tomorrow.md
|
||||
weatherreporter run evening
|
||||
```
|
||||
|
||||
For the 3-Day Outlook:
|
||||
|
||||
```sh
|
||||
weatherreporter generate three-day --out ./three-day.md
|
||||
```
|
||||
|
||||
## Command Overview
|
||||
|
||||
```text
|
||||
@@ -39,12 +46,14 @@ weatherreporter run morning
|
||||
weatherreporter run evening
|
||||
```
|
||||
|
||||
`generate daily` and `generate tomorrow` 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.
|
||||
Other `generate` commands resolve one report request and stop before report
|
||||
generation. Other `run` commands resolve a scheduled batch request and stop
|
||||
before execution.
|
||||
`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
|
||||
|
||||
@@ -52,7 +61,7 @@ before execution.
|
||||
- `--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` and `generate tomorrow`; reserved for later generated report output on other `generate` commands.
|
||||
- `--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`.
|
||||
|
||||
Reference in New Issue
Block a user