walkthrough-ui 0.2.0
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 +42 -0
- package/dist/LICENSE +21 -0
- package/dist/THIRD_PARTY_LICENSES.txt +1160 -0
- package/dist/uiwalk.mjs +113642 -0
- package/package.json +49 -0
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# walkthrough-ui
|
|
2
|
+
|
|
3
|
+
This package has `uiwalk`, the MCP server of [Walkthrough](https://github.com/mrigsby/walkthrough). It lets an AI agent test your web app in a visible Chrome, one step at a time, with you. After each step, you confirm it or report a bug in a panel in the browser.
|
|
4
|
+
|
|
5
|
+
In Claude Code, install the Walkthrough plugin instead. It includes this server, a skill, and slash commands:
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
/plugin marketplace add mrigsby/walkthrough
|
|
9
|
+
/plugin install walkthrough@walkthrough
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Use with other MCP clients
|
|
13
|
+
|
|
14
|
+
Add a local (stdio) server that runs `npx -y walkthrough-ui`. Set `UIWALK_PROJECT_DIR` to your project folder. For example, in Cursor (`.cursor/mcp.json`):
|
|
15
|
+
|
|
16
|
+
```json
|
|
17
|
+
{
|
|
18
|
+
"mcpServers": {
|
|
19
|
+
"uiwalk": {
|
|
20
|
+
"command": "npx",
|
|
21
|
+
"args": ["-y", "walkthrough-ui"],
|
|
22
|
+
"env": { "UIWALK_PROJECT_DIR": "${workspaceFolder}" }
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Commands
|
|
29
|
+
|
|
30
|
+
To use these commands, install the package with `npm install -g walkthrough-ui`. Or put `npx -y walkthrough-ui` in place of `uiwalk`, such as `npx -y walkthrough-ui doctor`.
|
|
31
|
+
|
|
32
|
+
| Command | What it does |
|
|
33
|
+
| --- | --- |
|
|
34
|
+
| `uiwalk` or `uiwalk serve` | Start the MCP server. |
|
|
35
|
+
| `uiwalk init` | Make the `.walkthrough` folder in the current folder. |
|
|
36
|
+
| `uiwalk doctor` | Check Node, Chrome, and the project settings. |
|
|
37
|
+
| `uiwalk setup` | Download Chrome for Testing, if Chrome is not installed. |
|
|
38
|
+
| `uiwalk schema` | Print the JSON Schema for test plans. |
|
|
39
|
+
|
|
40
|
+
Walkthrough needs Node.js 22.12 or later and Google Chrome.
|
|
41
|
+
|
|
42
|
+
See the [documentation](https://github.com/mrigsby/walkthrough#documentation) for the guides. MIT license.
|
package/dist/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Michael Rigsby
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|