Skip to content

Commit 3cef920

Browse files
committed
docs: clarify CLI args and stub status
1 parent 2449a6a commit 3cef920

2 files changed

Lines changed: 23 additions & 17 deletions

File tree

docs/PLUGIN.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,37 @@ plugin/manifest.json
2020
The plugin exposes the CLI commands directly. The general form is:
2121

2222
```sh
23-
dws-cli <command> [args]
23+
dws <command> [args]
2424
```
2525

26+
> Note: Several commands are **stubs** until the DWS API integration is wired in. They will emit placeholder output with `status: "stub"`.
27+
2628
### Examples
2729

2830
```sh
29-
dws-cli setup
31+
dws setup --api-key <key>
32+
```
33+
34+
```sh
35+
dws preflight <htmlPath>
3036
```
3137

3238
```sh
33-
dws-cli preflight
39+
dws convert <htmlPath> --output output.pdf --deterministic
3440
```
3541

3642
```sh
37-
dws-cli convert
43+
dws benchmark --suite W1-W6 --out results.json
3844
```
3945

4046
```sh
41-
dws-cli benchmark
47+
dws report --in results.json --out report.md
4248
```
4349

4450
```sh
45-
dws-cli report
51+
dws skills list
4652
```
4753

4854
```sh
49-
dws-cli skills
55+
dws skills add /path/to/skill
5056
```

plugin/manifest.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44
"description": "CLI for DWS setup, validation, conversion, benchmarking, reporting, and skills.",
55
"commands": {
66
"setup": {
7-
"command": "dws-cli setup",
7+
"command": "dws setup",
88
"description": "Initialize or configure the DWS environment."
99
},
1010
"preflight": {
11-
"command": "dws-cli preflight",
12-
"description": "Run preflight checks before conversion or benchmarks."
11+
"command": "dws preflight <htmlPath>",
12+
"description": "Run preflight checks on an HTML file (stub output)."
1313
},
1414
"convert": {
15-
"command": "dws-cli convert",
16-
"description": "Convert inputs using the DWS pipeline."
15+
"command": "dws convert <htmlPath> --output <path>",
16+
"description": "Convert HTML to PDF (stub output)."
1717
},
1818
"benchmark": {
19-
"command": "dws-cli benchmark",
20-
"description": "Run benchmarks against a dataset or config."
19+
"command": "dws benchmark --suite <name>",
20+
"description": "Run benchmark placeholders and write results JSON."
2121
},
2222
"report": {
23-
"command": "dws-cli report",
24-
"description": "Generate or view benchmark reports."
23+
"command": "dws report --in <results.json> --out <report.md>",
24+
"description": "Generate a markdown report from benchmark results."
2525
},
2626
"skills": {
27-
"command": "dws-cli skills",
27+
"command": "dws skills <subcommand>",
2828
"description": "List or manage DWS skills."
2929
}
3030
}

0 commit comments

Comments
 (0)