@miao-vision/cli 0.1.6 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -2
- package/dist/cli.cjs +14430 -11914
- package/dist/examples/finance-review-deck.yaml +110 -0
- package/dist/examples/finance-review.csv +7 -0
- package/dist/examples/ops-update-deck.yaml +106 -0
- package/dist/examples/ops-update.csv +7 -0
- package/dist/examples/product-metrics-deck.yaml +110 -0
- package/dist/examples/product-metrics.csv +7 -0
- package/dist/types.ts +23 -1
- package/examples/finance-review-deck.yaml +110 -0
- package/examples/finance-review.csv +7 -0
- package/examples/ops-update-deck.yaml +106 -0
- package/examples/ops-update.csv +7 -0
- package/examples/product-metrics-deck.yaml +110 -0
- package/examples/product-metrics.csv +7 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Miao Vision CLI
|
|
2
2
|
|
|
3
|
-
`miao-viz` is a local
|
|
3
|
+
`miao-viz` is a local visualization CLI for agent workflows. It reads local CSV, TSV, XLSX, and JSON files for data reports and decks, and local Markdown/text files for article-to-infographic artifacts.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -15,8 +15,21 @@ miao-viz profile ./examples/sales.csv
|
|
|
15
15
|
miao-viz catalog
|
|
16
16
|
miao-viz validate --spec ./examples/sales-dashboard.yaml --profile ./profile.json
|
|
17
17
|
miao-viz render --input ./examples/sales.csv --spec ./examples/sales-dashboard.yaml --output /tmp/miao-report.html
|
|
18
|
+
miao-viz deck --input ./examples/sales.csv --spec ./examples/sales-deck.yaml --output /tmp/miao-deck.html
|
|
19
|
+
miao-viz article ./article.md --style editorial --format html --output /tmp/article-infographic.html
|
|
18
20
|
```
|
|
19
21
|
|
|
22
|
+
Deck examples are included for several common presentation scenarios:
|
|
23
|
+
|
|
24
|
+
- `sales-deck.yaml`
|
|
25
|
+
- `product-metrics-deck.yaml`
|
|
26
|
+
- `finance-review-deck.yaml`
|
|
27
|
+
- `ops-update-deck.yaml`
|
|
28
|
+
|
|
29
|
+
Deck HTML supports arrow-key navigation, fullscreen mode, and browser print/PDF export.
|
|
30
|
+
|
|
31
|
+
DeckSpec validation returns structured repair information. `INVALID_DECK_SPEC` includes an `errors` array with `path`, `message`, and `hint`; `DECK_FIELD_NOT_FOUND` identifies missing fields in chart encodings, chart transforms, or metric transforms.
|
|
32
|
+
|
|
20
33
|
## Agent Usage
|
|
21
34
|
|
|
22
35
|
Install the CLI, then install the `miao-vision` skill for Codex or Claude. The skill will call `miao-viz` from your `PATH`.
|
|
@@ -24,5 +37,6 @@ Install the CLI, then install the `miao-vision` skill for Codex or Claude. The s
|
|
|
24
37
|
## Notes
|
|
25
38
|
|
|
26
39
|
- Default output format is HTML.
|
|
27
|
-
- PNG/PDF are not included in v1.
|
|
40
|
+
- PNG/PDF commands are not included in v1; deck HTML can be printed to PDF in the browser.
|
|
41
|
+
- `article` reads local Markdown/text only; agents should fetch URLs and normalize them before calling the CLI.
|
|
28
42
|
- The CLI does not call an LLM or require an API key.
|