Add filesystem state metadata baseline
This commit is contained in:
26
docs/cli.md
26
docs/cli.md
@@ -1,9 +1,10 @@
|
||||
# Weatherreporter CLI
|
||||
|
||||
`weatherreporter generate daily` currently writes a Daily prompt input data
|
||||
package and runs `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.
|
||||
`weatherreporter generate daily` currently writes managed Daily preparation
|
||||
artifacts under the configured workspace and runs `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.
|
||||
|
||||
## Shortest Useful Command
|
||||
|
||||
@@ -12,8 +13,9 @@ weatherreporter generate daily --date 2026-05-29 --out ./daily.data_package.json
|
||||
```
|
||||
|
||||
The command parses flags, loads configuration, fetches weather data, builds a
|
||||
Daily briefing, writes the `data_package` JSON artifact to `--out`, and invokes
|
||||
`scriptorium render --input data_package=<path> --format json`.
|
||||
Daily briefing, writes workspace artifacts, and invokes
|
||||
`scriptorium render --input data_package=<managed_path> --format json`. When
|
||||
`--out` is supplied, it also writes a copy of the data package to that path.
|
||||
|
||||
## Command Overview
|
||||
|
||||
@@ -27,11 +29,11 @@ weatherreporter run morning
|
||||
weatherreporter run evening
|
||||
```
|
||||
|
||||
`generate daily` writes a data package JSON artifact, writes the Daily briefing
|
||||
snapshot under the configured workspace, and writes the render preflight output
|
||||
under the configured workspace. Other `generate` commands resolve one report
|
||||
request and stop before report generation. `run` commands resolve a scheduled
|
||||
batch request and stop before execution.
|
||||
`generate daily` writes a briefing snapshot, prompt input data package, render
|
||||
preflight output, and metadata file under the configured workspace. Other
|
||||
`generate` commands resolve one report request and stop before report
|
||||
generation. `run` commands resolve a scheduled batch request and stop before
|
||||
execution.
|
||||
|
||||
## Flags
|
||||
|
||||
@@ -39,7 +41,7 @@ batch request and stop 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`: data package output path for `generate daily`; reserved for later generated report output on other `generate` commands.
|
||||
- `--out PATH`: optional extra data package copy 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`.
|
||||
|
||||
Reference in New Issue
Block a user