Skip to content

Commit 492f9bd

Browse files
committed
Merge task/t8-plugin
2 parents 484083c + 3cef920 commit 492f9bd

2 files changed

Lines changed: 87 additions & 0 deletions

File tree

docs/PLUGIN.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Claude Code Plugin: dws-cli
2+
3+
## Install
4+
5+
1. Build the CLI:
6+
7+
```sh
8+
npm install
9+
npm run build
10+
```
11+
12+
2. Add the plugin to Claude Code by pointing it at:
13+
14+
```
15+
plugin/manifest.json
16+
```
17+
18+
## Use
19+
20+
The plugin exposes the CLI commands directly. The general form is:
21+
22+
```sh
23+
dws <command> [args]
24+
```
25+
26+
> Note: Several commands are **stubs** until the DWS API integration is wired in. They will emit placeholder output with `status: "stub"`.
27+
28+
### Examples
29+
30+
```sh
31+
dws setup --api-key <key>
32+
```
33+
34+
```sh
35+
dws preflight <htmlPath>
36+
```
37+
38+
```sh
39+
dws convert <htmlPath> --output output.pdf --deterministic
40+
```
41+
42+
```sh
43+
dws benchmark --suite W1-W6 --out results.json
44+
```
45+
46+
```sh
47+
dws report --in results.json --out report.md
48+
```
49+
50+
```sh
51+
dws skills list
52+
```
53+
54+
```sh
55+
dws skills add /path/to/skill
56+
```

plugin/manifest.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "dws-cli",
3+
"version": "0.1.0",
4+
"description": "CLI for DWS setup, validation, conversion, benchmarking, reporting, and skills.",
5+
"commands": {
6+
"setup": {
7+
"command": "dws setup",
8+
"description": "Initialize or configure the DWS environment."
9+
},
10+
"preflight": {
11+
"command": "dws preflight <htmlPath>",
12+
"description": "Run preflight checks on an HTML file (stub output)."
13+
},
14+
"convert": {
15+
"command": "dws convert <htmlPath> --output <path>",
16+
"description": "Convert HTML to PDF (stub output)."
17+
},
18+
"benchmark": {
19+
"command": "dws benchmark --suite <name>",
20+
"description": "Run benchmark placeholders and write results JSON."
21+
},
22+
"report": {
23+
"command": "dws report --in <results.json> --out <report.md>",
24+
"description": "Generate a markdown report from benchmark results."
25+
},
26+
"skills": {
27+
"command": "dws skills <subcommand>",
28+
"description": "List or manage DWS skills."
29+
}
30+
}
31+
}

0 commit comments

Comments
 (0)