pi-web-ui 0.10.0 → 0.10.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.
Files changed (2) hide show
  1. package/README.md +31 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -72,6 +72,37 @@ npm i -g .
72
72
  > install scripts, approve node-pty's native build once after installing:
73
73
  > `npm approve-scripts node-pty@1.1.0` (standard npm does this automatically).
74
74
 
75
+ ### As a pi package (web UI inside pi)
76
+
77
+ `pi-web-ui` is also published as a **pi package** (`pi-package` on npm) so it
78
+ can be installed and used from within a pi session:
79
+
80
+ ```bash
81
+ pi install npm:pi-web-ui
82
+ ```
83
+
84
+ Once installed, a `/webui` command becomes available inside pi, launching the
85
+ local web UI against your current working directory:
86
+
87
+ ```
88
+ /webui # start + open browser (current dir)
89
+ /webui --port 9000 # start on a specific port
90
+ /webui --no-browser # start without opening the browser
91
+ /webui stop # stop the running instance
92
+ /webui status # show URL / status
93
+ ```
94
+
95
+ > **Note — `pi install` is NOT a global CLI install.**
96
+ >
97
+ > `pi install npm:pi-web-ui` only loads the package into pi's extension tree
98
+ > (`~/.pi/agent/npm/node_modules/`) and registers its extension for pi sessions.
99
+ > It does **not** put a `pi-web-ui` executable on your shell `PATH`, so you
100
+ > cannot run the `pi-web-ui` terminal command from that install. For the CLI you
101
+ > still need the global npm install above (`npm i -g pi-web-ui`), which is what
102
+ > `which pi-web-ui` resolves to. `pi install` ≠ `npm i -g`: one is for pi
103
+ > extensions, the other for a system-wide command. Both can coexist (the global
104
+ > 0.x CLI for terminal use, the pi package for the `/webui` in-pi entry).
105
+
75
106
  ### Start
76
107
 
77
108
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pi-web-ui",
3
- "version": "0.10.0",
3
+ "version": "0.10.1",
4
4
  "description": "Web chat interface for the pi coding agent, powered by the pi SDK (@earendil-works/pi-coding-agent) — one-command run, Docker/systemd/launchd deployable",
5
5
  "license": "MIT",
6
6
  "type": "module",