uisnap 0.1.0 ā 0.1.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/CHANGELOG.md +15 -0
- package/README.md +33 -5
- package/package.json +10 -9
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.1.1] - 2026-01-02
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
**Improved npm package discoverability and onboarding:**
|
|
13
|
+
|
|
14
|
+
- **Package description** - Now explicitly states "CLI debugging tool designed for AI coding agents"
|
|
15
|
+
- **Keywords** - Added "ai", "ai-agent", "cursor" for better npm search results
|
|
16
|
+
- **README intro** - Added "Why uisnap?" section with token efficiency comparison
|
|
17
|
+
- **Installation guide** - Clearer Claude Code skill installation steps with benefits explained
|
|
18
|
+
- **Postinstall message** - Now emphasizes AI agent use case and includes skill installation instructions
|
|
19
|
+
|
|
20
|
+
No functional changes - purely documentation and messaging improvements.
|
|
21
|
+
|
|
8
22
|
## [0.1.0] - 2026-01-02
|
|
9
23
|
|
|
10
24
|
**Initial release of uisnap** (formerly playwright-debug-toolkit)
|
|
@@ -93,4 +107,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
93
107
|
- `.claude/skills/uisnap/` - Skill definition and reference docs
|
|
94
108
|
- `examples/` - Sample scripts for common debugging workflows
|
|
95
109
|
|
|
110
|
+
[0.1.1]: https://github.com/tonyhschu/uisnap/releases/tag/v0.1.1
|
|
96
111
|
[0.1.0]: https://github.com/tonyhschu/uisnap/releases/tag/v0.1.0
|
package/README.md
CHANGED
|
@@ -1,24 +1,43 @@
|
|
|
1
1
|
# uisnap
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**CLI debugging tool designed for AI coding agents**
|
|
4
|
+
|
|
5
|
+
Stop having your AI assistant repeatedly reload pages and parse megabytes of DOM. Capture browser state once, query efficiently many times.
|
|
6
|
+
|
|
7
|
+
## Why uisnap?
|
|
8
|
+
|
|
9
|
+
When AI agents debug frontend issues, they typically:
|
|
10
|
+
1. š“ Load the full page HTML (~15K tokens)
|
|
11
|
+
2. š“ Parse console logs (~8K tokens)
|
|
12
|
+
3. š“ Analyze network requests (~5K tokens)
|
|
13
|
+
4. š“ Repeat for every question
|
|
14
|
+
|
|
15
|
+
**uisnap changes this:**
|
|
16
|
+
1. ā
Capture once: ~2K tokens
|
|
17
|
+
2. ā
Query many times: ~200 tokens each
|
|
18
|
+
3. ā
**17x token reduction**
|
|
4
19
|
|
|
5
20
|
## Philosophy
|
|
6
21
|
|
|
7
|
-
**Capture once, query many** - Expensive browser operations write to disk once. Cheap local queries analyze data repeatedly without re-running the browser.
|
|
22
|
+
**Capture once, query many** - Expensive browser operations write to disk once. Cheap local queries analyze data repeatedly without re-running the browser.
|
|
23
|
+
|
|
24
|
+
**Built for**: Claude Code, Cursor, Aider, and other AI coding assistants.
|
|
8
25
|
|
|
9
26
|
## Installation
|
|
10
27
|
|
|
28
|
+
### 1. Install the CLI tool
|
|
29
|
+
|
|
11
30
|
```bash
|
|
12
31
|
npm install -g uisnap
|
|
13
32
|
npx playwright install chromium
|
|
14
33
|
```
|
|
15
34
|
|
|
16
|
-
###
|
|
35
|
+
### 2. Install Claude Code Skill (Recommended for Claude Code users)
|
|
17
36
|
|
|
18
|
-
|
|
37
|
+
**Teach Claude when and how to use uisnap automatically:**
|
|
19
38
|
|
|
20
39
|
```bash
|
|
21
|
-
# For team sharing (recommended):
|
|
40
|
+
# For team sharing (recommended - commit to git):
|
|
22
41
|
mkdir -p .claude/skills
|
|
23
42
|
cp -r node_modules/uisnap/.claude/skills/uisnap .claude/skills/
|
|
24
43
|
git add .claude/skills/
|
|
@@ -28,6 +47,15 @@ mkdir -p ~/.claude/skills
|
|
|
28
47
|
cp -r node_modules/uisnap/.claude/skills/uisnap ~/.claude/skills/
|
|
29
48
|
```
|
|
30
49
|
|
|
50
|
+
Once installed, Claude Code will automatically know:
|
|
51
|
+
- ā
When to capture browser state vs. parse HTML
|
|
52
|
+
- ā
How to use each analysis command
|
|
53
|
+
- ā
Best practices for token-efficient debugging
|
|
54
|
+
|
|
55
|
+
**Without the skill:** You'll need to manually tell Claude which commands to use.
|
|
56
|
+
|
|
57
|
+
**With the skill:** Just say "debug console errors on example.com" and Claude handles the rest.
|
|
58
|
+
|
|
31
59
|
See [SKILL-INSTALLATION.md](./SKILL-INSTALLATION.md) for details.
|
|
32
60
|
|
|
33
61
|
## Quick Start
|
package/package.json
CHANGED
|
@@ -1,19 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "uisnap",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "CLI debugging tool designed for AI coding agents. Captures browser state to disk for token-efficient analysis. Works with Claude Code, Cursor, and other AI assistants.",
|
|
5
5
|
"author": "Tony Chu",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"keywords": [
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
"
|
|
8
|
+
"ai",
|
|
9
|
+
"ai-agent",
|
|
10
|
+
"claude-code",
|
|
11
|
+
"cursor",
|
|
11
12
|
"debugging",
|
|
12
13
|
"frontend",
|
|
13
|
-
"ui",
|
|
14
14
|
"playwright",
|
|
15
|
-
"
|
|
16
|
-
"
|
|
15
|
+
"snapshot",
|
|
16
|
+
"browser-automation",
|
|
17
|
+
"testing"
|
|
17
18
|
],
|
|
18
19
|
"repository": {
|
|
19
20
|
"type": "git",
|
|
@@ -53,7 +54,7 @@
|
|
|
53
54
|
"test:coverage": "vitest run --coverage",
|
|
54
55
|
"prepublishOnly": "npm run clean && npm run build",
|
|
55
56
|
"dev": "npm run build && node dist/pw.js",
|
|
56
|
-
"postinstall": "echo '\nā uisnap installed!\n\
|
|
57
|
+
"postinstall": "echo '\nā uisnap installed!\n\nš IMPORTANT: This tool is designed for AI coding agents.\n\nQuick start:\n 1. Install Chromium: npx playwright install chromium\n 2. Install Claude Code skill (optional but recommended):\n mkdir -p .claude/skills\n cp -r node_modules/uisnap/.claude/skills/uisnap .claude/skills/\n 3. Try it: uisnap snapshot https://example.com\n\nSee: https://github.com/tonyhschu/uisnap#installing-the-claude-code-skill\n'"
|
|
57
58
|
},
|
|
58
59
|
"dependencies": {
|
|
59
60
|
"adm-zip": "^0.5.16",
|