openui-cli 0.0.1
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 +60 -0
- package/dist/THIRD_PARTY_LICENSES.txt +4 -0
- package/dist/build-meta.json +12370 -0
- package/dist/index.cjs +64780 -0
- package/dist/index.cjs.map +7 -0
- package/dist/plugins/angular/index.js +115 -0
- package/dist/plugins/react/index.js +91 -0
- package/dist/plugins/vue/index.js +120 -0
- package/dist/toolbar-bridged/.vite/manifest.json +28 -0
- package/dist/toolbar-bridged/button-Bxo0J6jh.js +8712 -0
- package/dist/toolbar-bridged/button-DVVGO14L.js +8709 -0
- package/dist/toolbar-bridged/button-DbIfmzgF.js +8713 -0
- package/dist/toolbar-bridged/index-BGXheXwf.js +8709 -0
- package/dist/toolbar-bridged/index.js +14614 -0
- package/dist/toolbar-bridged/plugin-sdk.js +109 -0
- package/dist/toolbar-bridged/toolbar-bridged.css +1 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# OpenUI CLI
|
|
2
|
+
|
|
3
|
+
The command-line interface for OpenUI — select UI elements in your browser, describe changes, and forward prompts to your IDE's AI agent.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx openui@latest
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or with pnpm:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm dlx openui@latest
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## What it does
|
|
18
|
+
|
|
19
|
+
1. Starts a proxy server that overlays the OpenUI toolbar onto your running dev app
|
|
20
|
+
2. Discovers framework plugins (React, Vue, Angular) automatically
|
|
21
|
+
3. Connects to the OpenUI VS Code extension to forward prompts to your IDE
|
|
22
|
+
|
|
23
|
+
## Options
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
Usage: openui [options] [-- command]
|
|
27
|
+
|
|
28
|
+
Options:
|
|
29
|
+
-p, --port <port> Proxy port (default: 3100)
|
|
30
|
+
-a, --app-port <port> Your dev app port (default: prompt)
|
|
31
|
+
-w, --workspace <path> Workspace path (default: cwd)
|
|
32
|
+
-s, --silent Suppress banner output
|
|
33
|
+
-v, --verbose Enable debug logging
|
|
34
|
+
-h, --help Show help
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Command Wrapping
|
|
38
|
+
|
|
39
|
+
Run your dev server and OpenUI together:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx openui@latest -- npm run dev
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Agent Support
|
|
46
|
+
|
|
47
|
+
| Agent | Supported |
|
|
48
|
+
|---|---|
|
|
49
|
+
| Cursor | ✅ |
|
|
50
|
+
| GitHub Copilot | ✅ |
|
|
51
|
+
| Windsurf | ✅ |
|
|
52
|
+
| Cline | ✅ |
|
|
53
|
+
| Roo Code | ✅ |
|
|
54
|
+
| Kilo Code | ✅ |
|
|
55
|
+
| Trae | ✅ |
|
|
56
|
+
| Antigravity | ✅ |
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
AGPLv3 — see [LICENSE](../../LICENSE) for details.
|