@imge/cli 0.0.1 → 0.1.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/LICENSE +21 -0
- package/README.md +80 -1
- package/assets/demo.gif +0 -0
- package/dist/cli.js +697 -0
- package/package.json +42 -15
- package/ui/dist/assets/geist-mono-BoRIzn25.woff2 +0 -0
- package/ui/dist/assets/geist-sans-BNK-hTUD.woff2 +0 -0
- package/ui/dist/assets/index-Ieep9RH_.css +1 -0
- package/ui/dist/assets/index-qo8YHnNN.js +10 -0
- package/ui/dist/index.html +13 -0
- package/ui/src/FONT-LICENSE.txt +92 -0
- package/index.js +0 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Berkay Demirbaş
|
|
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.
|
package/README.md
CHANGED
|
@@ -1,3 +1,82 @@
|
|
|
1
1
|
# imge
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+

|
|
4
|
+
|
|
5
|
+
**See what your agent saw.** imge records browser actions made through its Playwright MCP proxy and lets you replay the screenshots alongside the accessibility text the agent received. Sessions stay on your machine.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
Requires Node.js 20+ and an MCP client. Install directly with NPX:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx --yes @imge/cli@latest setup --client codex
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Replace `codex` with `cursor`, `claude-code`, `claude-desktop`, or `vs-code`. Omit `--client` to configure all five. The setup command shows the proposed config and asks before writing it. Restart your agent after installation.
|
|
16
|
+
|
|
17
|
+
Alternatively, paste this sentence into your AI coding agent:
|
|
18
|
+
|
|
19
|
+
> Install imge for this agent. Identify whether you are Codex, Cursor, Claude Code, Claude Desktop, or VS Code. Run `npx --yes @imge/cli@latest setup --client <client> --yes`, then show me how to use imge and uninstall it.
|
|
20
|
+
|
|
21
|
+
The agent still runs the same NPX command; the sentence is a convenient way to ask it to do the setup. `--yes` on the setup command skips imge's interactive confirmation because the instruction authorizes the config change. The first `--yes` is for NPX's package install prompt.
|
|
22
|
+
|
|
23
|
+
### Client configuration
|
|
24
|
+
|
|
25
|
+
| Client | Config file | Direct command |
|
|
26
|
+
|---|---|---|
|
|
27
|
+
| Codex | `~/.codex/config.toml` | `npx --yes @imge/cli@latest setup --client codex` |
|
|
28
|
+
| Cursor | `~/.cursor/mcp.json` | `npx --yes @imge/cli@latest setup --client cursor` |
|
|
29
|
+
| Claude Code | `~/.claude.json` | `npx --yes @imge/cli@latest setup --client claude-code` |
|
|
30
|
+
| Claude Desktop | Claude's desktop config | `npx --yes @imge/cli@latest setup --client claude-desktop` |
|
|
31
|
+
| VS Code | `~/.copilot/mcp-config.json` | `npx --yes @imge/cli@latest setup --client vs-code` |
|
|
32
|
+
|
|
33
|
+
The installed MCP entry runs `npx --yes @imge/cli@latest mcp`. imge backs up an existing config before editing it and leaves other MCP servers in place.
|
|
34
|
+
|
|
35
|
+
## Record a session
|
|
36
|
+
|
|
37
|
+
Ask a configured agent:
|
|
38
|
+
|
|
39
|
+
> Use the imge browser tools to open https://example.com, describe the page, and click a link.
|
|
40
|
+
|
|
41
|
+
The agent must use the **imge MCP browser tools**. Its built-in browser will not be recorded. In another terminal, open the local player:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npx --yes @imge/cli@latest
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The player runs at `http://localhost:4747`. One MCP process creates one session in `~/.imge/mcp/sessions/<sessionId>/`, with `steps.jsonl` and a PNG for each action. The player shows the screenshot and the text the agent saw, plus errors and same-name warnings. Password and card fields are masked in saved text and screenshots.
|
|
48
|
+
|
|
49
|
+
## Uninstall
|
|
50
|
+
|
|
51
|
+
After installing the MCP server, remove its entry from the same client config and restart the agent:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx --yes @imge/cli@latest uninstall --client codex
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Use the relevant client name from the table above, or omit `--client` to remove imge from all five. The command asks before changing files, backs up changed configs, and preserves other MCP entries. To remove a globally installed npm executable, also run `npm uninstall -g @imge/cli` if you installed it globally. NPX itself needs no global uninstall.
|
|
58
|
+
|
|
59
|
+
Saved sessions are independent of the MCP config. To delete them, run `npx --yes @imge/cli@latest clear` and confirm. This deletes recordings under `~/.imge/mcp/sessions/`.
|
|
60
|
+
|
|
61
|
+
## Commands
|
|
62
|
+
|
|
63
|
+
| Command | Action |
|
|
64
|
+
|---|---|
|
|
65
|
+
| `npx --yes @imge/cli@latest setup [--client <name>]` | Install the MCP entry. |
|
|
66
|
+
| `npx --yes @imge/cli@latest uninstall [--client <name>]` | Remove the MCP entry. |
|
|
67
|
+
| `npx --yes @imge/cli@latest mcp` | Run the stdio browser proxy. |
|
|
68
|
+
| `npx --yes @imge/cli@latest` | Open the local player. |
|
|
69
|
+
| `npx --yes @imge/cli@latest clear` | Delete recordings after confirmation. |
|
|
70
|
+
|
|
71
|
+
## Development
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
bun install
|
|
75
|
+
bun run check
|
|
76
|
+
bun test
|
|
77
|
+
bun run build
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
The build runs on Node 20+ without Bun. The proxy forwards Playwright MCP calls and results without modifying what the agent sees. It launches Chrome through CDP and captures screenshots from a separate connection. It does not capture browser network traffic or agents using their own cloud browser.
|
|
81
|
+
|
|
82
|
+
MIT licensed. Source: [imge-ai/cli](https://github.com/imge-ai/cli).
|
package/assets/demo.gif
ADDED
|
Binary file
|