@bewa/cdp-cli 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/AGENT.md +97 -0
- package/LICENSE +190 -0
- package/README.md +259 -0
- package/bin/cdp-cli.js +66 -0
- package/lib/browser.js +96 -0
- package/lib/cdp.js +116 -0
- package/lib/commands/eval.js +56 -0
- package/lib/commands/init.js +73 -0
- package/lib/commands/launch.js +44 -0
- package/lib/commands/navigate.js +22 -0
- package/lib/commands/reload.js +32 -0
- package/lib/commands/targets.js +20 -0
- package/lib/config.js +94 -0
- package/lib/output.js +38 -0
- package/lib/ws.js +166 -0
- package/package.json +34 -0
package/AGENT.md
ADDED
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# cdp-cli — AI Assistant Usage Guide
|
|
2
|
+
|
|
3
|
+
You have access to `cdp-cli`, a CLI tool for interacting with browsers via Chrome DevTools Protocol. Use it to inspect pages, evaluate JS, and diagnose DOM issues during development.
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
cdp-cli launch # Start browser (auto-detects Chrome/Canary/Chromium)
|
|
9
|
+
cdp-cli launch --extension ./ext # Start with Chrome extension loaded
|
|
10
|
+
cdp-cli targets # List open pages (get target IDs)
|
|
11
|
+
cdp-cli eval <id> "<js>" # Evaluate JS in page (async auto-awaited)
|
|
12
|
+
cdp-cli eval-file <id> script.js # Evaluate JS file in page
|
|
13
|
+
cdp-cli reload [id] # Reload tab(s) after code changes
|
|
14
|
+
cdp-cli navigate <id> <url> # Navigate tab to URL
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Target IDs are 8-char hex strings from `targets` output. Prefix match with minimum 4 chars.
|
|
18
|
+
|
|
19
|
+
All output is JSON (one object per line). Errors go to stderr as `{"error":"..."}`.
|
|
20
|
+
|
|
21
|
+
## When to Use
|
|
22
|
+
|
|
23
|
+
- **DOM debugging**: content scripts can't find elements, selectors don't match, content is empty
|
|
24
|
+
- **Lazy loading / virtualization**: elements exist but have no rendered content until scrolled into view
|
|
25
|
+
- **Verifying code changes**: reload page and re-evaluate after editing content scripts
|
|
26
|
+
- **Page inspection**: check what's actually in the DOM vs what you expect
|
|
27
|
+
|
|
28
|
+
## Typical Debug Loop
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
cdp-cli launch # 1. Start browser
|
|
32
|
+
# User opens the target page
|
|
33
|
+
cdp-cli targets # 2. Find target ID
|
|
34
|
+
cdp-cli eval 8FEE "document.querySelectorAll('.item').length" # 3. Diagnose
|
|
35
|
+
# Edit code
|
|
36
|
+
cdp-cli reload 8FEE # 4. Reload
|
|
37
|
+
cdp-cli eval 8FEE "document.querySelectorAll('.item').length" # 5. Verify
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Diagnostic Patterns
|
|
41
|
+
|
|
42
|
+
### Check if elements exist but have empty content (DOM virtualization)
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
cdp-cli eval <id> "
|
|
46
|
+
(() => {
|
|
47
|
+
const items = document.querySelectorAll('<selector>');
|
|
48
|
+
return JSON.stringify(Array.from(items).map((el, i) => ({
|
|
49
|
+
i, hasText: !!el.innerText.trim(), text: el.innerText.substring(0, 80)
|
|
50
|
+
})));
|
|
51
|
+
})()"
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
If elements exist with empty text, the page uses DOM virtualization — content only renders in viewport.
|
|
55
|
+
|
|
56
|
+
### Test selector chains step by step
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
cdp-cli eval <id> "
|
|
60
|
+
JSON.stringify({
|
|
61
|
+
parent: document.querySelectorAll('parent-selector').length,
|
|
62
|
+
child: document.querySelectorAll('parent > child').length,
|
|
63
|
+
target: document.querySelectorAll('parent > child .target').length
|
|
64
|
+
})"
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Scroll element into view and check content
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
cdp-cli eval <id> "
|
|
71
|
+
(async () => {
|
|
72
|
+
const el = document.querySelectorAll('<selector>')[0];
|
|
73
|
+
el.scrollIntoView({ behavior: 'instant', block: 'center' });
|
|
74
|
+
await new Promise(r => setTimeout(r, 1000));
|
|
75
|
+
return JSON.stringify({ text: el.innerText.substring(0, 500) });
|
|
76
|
+
})()"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Configuration
|
|
80
|
+
|
|
81
|
+
Config file `.cdprc.json` in project root (auto-detected):
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
{
|
|
85
|
+
"browser": "canary",
|
|
86
|
+
"port": 9222,
|
|
87
|
+
"extensions": ["./my-extension"]
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
CLI flags override config: `--port`, `--browser`, `--timeout`, `--extension`.
|
|
92
|
+
|
|
93
|
+
## Important Notes
|
|
94
|
+
|
|
95
|
+
- `eval` runs in the **page's main world**, not in extension content script isolated worlds. `chrome.runtime` and other extension APIs are not available.
|
|
96
|
+
- To test content script functions, copy the relevant code into the eval expression.
|
|
97
|
+
- After modifying a service worker (background.js), you must reload the extension in `chrome://extensions` — `cdp-cli reload` only reloads page content scripts.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding any notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright 2026 cdp-cli contributors
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
# cdp-cli Design Document
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
A zero-dependency CLI tool that bridges AI coding assistants (Claude Code, Codex, Gemini CLI, OpenCode, etc.) with browsers via Chrome DevTools Protocol. Purpose: let AI agents **see and interact with** browser pages during development — inspect DOM, evaluate JS, diagnose rendering issues.
|
|
6
|
+
|
|
7
|
+
**Not** a browser automation framework. Not competing with Puppeteer/Playwright. This is a diagnostic/observation tool optimized for AI consumption.
|
|
8
|
+
|
|
9
|
+
## Commands
|
|
10
|
+
|
|
11
|
+
### `cdp-cli launch`
|
|
12
|
+
|
|
13
|
+
Start a browser with CDP enabled.
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
cdp-cli launch # auto-detect browser
|
|
17
|
+
cdp-cli launch --browser chrome # specific browser
|
|
18
|
+
cdp-cli launch --port 9333 # custom port
|
|
19
|
+
cdp-cli launch --extension ./my-ext # load Chrome extension
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Behavior:
|
|
23
|
+
- If browser already running on target port, print status and exit (no error)
|
|
24
|
+
- Auto-detect browser: canary > chrome > chromium > edge
|
|
25
|
+
- Spawn detached process, wait until CDP port responds, then exit
|
|
26
|
+
- Output: `{"ok":true,"browser":"canary","port":9222,"pid":12345}`
|
|
27
|
+
|
|
28
|
+
### `cdp-cli targets`
|
|
29
|
+
|
|
30
|
+
List debuggable page targets.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
cdp-cli targets
|
|
34
|
+
cdp-cli targets --json # explicit JSON (default)
|
|
35
|
+
cdp-cli targets --human # human-readable table
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Output (JSON, one object per line for easy grep):
|
|
39
|
+
```json
|
|
40
|
+
{"id":"8FEE852A","title":"My Page","url":"https://example.com"}
|
|
41
|
+
{"id":"09A0487E","title":"Settings","url":"chrome-extension://abc/options.html"}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Short IDs (first 8 chars) — sufficient for all other commands.
|
|
45
|
+
|
|
46
|
+
### `cdp-cli eval <target> <expression>`
|
|
47
|
+
|
|
48
|
+
Evaluate JavaScript in a page context.
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
cdp-cli eval 8FEE852A "document.title"
|
|
52
|
+
cdp-cli eval 8FEE "document.querySelectorAll('div').length" # prefix match
|
|
53
|
+
cdp-cli eval 8FEE "(async () => { await fetch('/api'); return 'done'; })()"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Behavior:
|
|
57
|
+
- Target ID prefix-matched (minimum 4 chars)
|
|
58
|
+
- Async expressions auto-awaited (`awaitPromise: true`)
|
|
59
|
+
- String results that are valid JSON get parsed and re-formatted
|
|
60
|
+
- Timeout: 30s default, configurable via `--timeout`
|
|
61
|
+
- Output: the return value, JSON-formatted
|
|
62
|
+
|
|
63
|
+
Errors:
|
|
64
|
+
```json
|
|
65
|
+
{"error":"ReferenceError: foo is not defined","stack":"..."}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### `cdp-cli eval-file <target> <file>`
|
|
69
|
+
|
|
70
|
+
Evaluate JS from a file. Alias for reading file + eval.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
cdp-cli eval-file 8FEE ./diagnose.js
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### `cdp-cli reload [target]`
|
|
77
|
+
|
|
78
|
+
Reload page(s) to pick up code changes.
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
cdp-cli reload 8FEE # reload specific tab
|
|
82
|
+
cdp-cli reload # reload all non-chrome:// tabs
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Output:
|
|
86
|
+
```json
|
|
87
|
+
{"reloaded":["8FEE852A"]}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### `cdp-cli navigate <target> <url>`
|
|
91
|
+
|
|
92
|
+
Navigate a tab to a URL.
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
cdp-cli navigate 8FEE "https://example.com"
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `cdp-cli init`
|
|
99
|
+
|
|
100
|
+
Generate config and optionally inject AI assistant references.
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
cdp-cli init # create .cdprc.json with defaults
|
|
104
|
+
cdp-cli init --agent # also append reference to CLAUDE.md / .cursorrules
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Configuration
|
|
108
|
+
|
|
109
|
+
### `.cdprc.json`
|
|
110
|
+
|
|
111
|
+
```jsonc
|
|
112
|
+
{
|
|
113
|
+
"browser": "canary", // canary | chrome | chromium | edge | "/full/path"
|
|
114
|
+
"port": 9222,
|
|
115
|
+
"userDataDir": "/tmp/cdp-debug-profile",
|
|
116
|
+
"extensions": [], // extension directory paths (resolved relative to .cdprc.json)
|
|
117
|
+
"launchArgs": [], // extra args passed to browser
|
|
118
|
+
"timeout": 30000 // default eval timeout in ms
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Priority
|
|
123
|
+
|
|
124
|
+
CLI flags > `.cdprc.json` (nearest ancestor) > built-in defaults.
|
|
125
|
+
|
|
126
|
+
`.cdprc.json` is searched upward from cwd, like `.npmrc`.
|
|
127
|
+
|
|
128
|
+
### Built-in Defaults
|
|
129
|
+
|
|
130
|
+
```json
|
|
131
|
+
{
|
|
132
|
+
"browser": "auto",
|
|
133
|
+
"port": 9222,
|
|
134
|
+
"userDataDir": "/tmp/cdp-debug-profile",
|
|
135
|
+
"extensions": [],
|
|
136
|
+
"launchArgs": [],
|
|
137
|
+
"timeout": 30000
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Output Design
|
|
142
|
+
|
|
143
|
+
**Default: JSON** — one JSON object per logical result. AI agents parse it directly.
|
|
144
|
+
|
|
145
|
+
**`--human` flag**: switches to human-readable format for manual use.
|
|
146
|
+
|
|
147
|
+
All errors go to stderr as JSON: `{"error":"message"}`. Exit code 1 on failure.
|
|
148
|
+
|
|
149
|
+
## Browser Detection
|
|
150
|
+
|
|
151
|
+
Auto-detect order, per platform:
|
|
152
|
+
|
|
153
|
+
**macOS:**
|
|
154
|
+
1. Google Chrome Canary → `/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary`
|
|
155
|
+
2. Google Chrome → `/Applications/Google Chrome.app/Contents/MacOS/Google Chrome`
|
|
156
|
+
3. Chromium → `/Applications/Chromium.app/Contents/MacOS/Chromium`
|
|
157
|
+
4. Microsoft Edge → `/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge`
|
|
158
|
+
|
|
159
|
+
**Linux:**
|
|
160
|
+
1. `google-chrome-canary`
|
|
161
|
+
2. `google-chrome` / `google-chrome-stable`
|
|
162
|
+
3. `chromium` / `chromium-browser`
|
|
163
|
+
4. `microsoft-edge`
|
|
164
|
+
|
|
165
|
+
**Windows:**
|
|
166
|
+
1. `%LOCALAPPDATA%\Google\Chrome SxS\Application\chrome.exe`
|
|
167
|
+
2. `%PROGRAMFILES%\Google\Chrome\Application\chrome.exe`
|
|
168
|
+
3. `%PROGRAMFILES%\Chromium\Application\chrome.exe`
|
|
169
|
+
4. `%PROGRAMFILES(x86)%\Microsoft\Edge\Application\msedge.exe`
|
|
170
|
+
|
|
171
|
+
Resolved via `fs.existsSync` (macOS/Windows) or `which` (Linux).
|
|
172
|
+
|
|
173
|
+
## AI Discovery
|
|
174
|
+
|
|
175
|
+
### `--help` Output
|
|
176
|
+
|
|
177
|
+
Designed for AI consumption — compact, example-driven:
|
|
178
|
+
|
|
179
|
+
```
|
|
180
|
+
cdp-cli — Browser DevTools bridge for AI coding assistants
|
|
181
|
+
|
|
182
|
+
Commands:
|
|
183
|
+
launch Start browser with CDP enabled
|
|
184
|
+
targets List debuggable pages
|
|
185
|
+
eval <id> <js> Evaluate JS in page context
|
|
186
|
+
eval-file <id> <f> Evaluate JS file in page context
|
|
187
|
+
reload [id] Reload page(s)
|
|
188
|
+
navigate <id> <url> Navigate to URL
|
|
189
|
+
init [--agent] Generate .cdprc.json (--agent: inject AI assistant reference)
|
|
190
|
+
|
|
191
|
+
Examples:
|
|
192
|
+
cdp-cli launch
|
|
193
|
+
cdp-cli targets
|
|
194
|
+
cdp-cli eval 8FEE "document.querySelectorAll('.item').length"
|
|
195
|
+
cdp-cli reload
|
|
196
|
+
|
|
197
|
+
Config: .cdprc.json (searched upward from cwd)
|
|
198
|
+
Flags: --port, --browser, --timeout, --human, --help, --version
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### AGENT.md
|
|
202
|
+
|
|
203
|
+
Shipped in the npm package. Contains:
|
|
204
|
+
- When to use this tool (DOM debugging, content script issues, page inspection)
|
|
205
|
+
- Command reference with examples
|
|
206
|
+
- Common diagnostic patterns (DOM virtualization, selector debugging, lazy loading)
|
|
207
|
+
- Typical debug loop workflow
|
|
208
|
+
|
|
209
|
+
Referenced by AI assistants via CLAUDE.md, .cursorrules, etc.
|
|
210
|
+
|
|
211
|
+
### `init --agent`
|
|
212
|
+
|
|
213
|
+
Detects which AI config files exist and appends a one-liner:
|
|
214
|
+
|
|
215
|
+
- `CLAUDE.md` → for Claude Code
|
|
216
|
+
- `.cursorrules` → for Cursor
|
|
217
|
+
- `.github/copilot-instructions.md` → for Copilot
|
|
218
|
+
- `AGENTS.md` → for Codex
|
|
219
|
+
|
|
220
|
+
Appended content:
|
|
221
|
+
```markdown
|
|
222
|
+
## Browser Debugging
|
|
223
|
+
This project uses `cdp-cli` for browser debugging. Run `cdp-cli --help` for commands, or see `node_modules/@kiss/cdp-cli/AGENT.md` for AI usage guide.
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## Project Structure
|
|
227
|
+
|
|
228
|
+
```
|
|
229
|
+
cdp-cli/
|
|
230
|
+
├── bin/
|
|
231
|
+
│ └── cdp-cli.js # CLI entry point (shebang)
|
|
232
|
+
├── lib/
|
|
233
|
+
│ ├── browser.js # Browser detection & launch
|
|
234
|
+
│ ├── cdp.js # CDP connection (HTTP + WebSocket)
|
|
235
|
+
│ ├── commands/
|
|
236
|
+
│ │ ├── launch.js
|
|
237
|
+
│ │ ├── targets.js
|
|
238
|
+
│ │ ├── eval.js
|
|
239
|
+
│ │ ├── reload.js
|
|
240
|
+
│ │ ├── navigate.js
|
|
241
|
+
│ │ └── init.js
|
|
242
|
+
│ ├── config.js # .cdprc.json resolution & merging
|
|
243
|
+
│ ├── output.js # JSON/human output formatting
|
|
244
|
+
│ └── ws.js # Minimal WebSocket client (no deps)
|
|
245
|
+
├── AGENT.md # AI assistant usage guide
|
|
246
|
+
├── DESIGN.md # This file
|
|
247
|
+
├── README.md # Human documentation
|
|
248
|
+
├── LICENSE # Apache 2.0
|
|
249
|
+
├── package.json
|
|
250
|
+
└── .cdprc.json.example
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
## Technical Decisions
|
|
254
|
+
|
|
255
|
+
- **Zero production dependencies**: HTTP via `node:http`, args via `node:util.parseArgs`, WebSocket via custom minimal implementation
|
|
256
|
+
- **Node >= 18**: for `parseArgs` support
|
|
257
|
+
- **Short target IDs**: first 8 hex chars, prefix-matchable with minimum 4
|
|
258
|
+
- **Stateless**: every command connects, acts, disconnects. No daemon, no session
|
|
259
|
+
- **Cross-platform**: macOS, Linux, Windows browser paths maintained
|
package/bin/cdp-cli.js
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
'use strict';
|
|
3
|
+
|
|
4
|
+
const { parseArgs } = require('node:util');
|
|
5
|
+
const { version } = require('../package.json');
|
|
6
|
+
|
|
7
|
+
const COMMANDS = {
|
|
8
|
+
launch: () => require('../lib/commands/launch'),
|
|
9
|
+
targets: () => require('../lib/commands/targets'),
|
|
10
|
+
eval: () => require('../lib/commands/eval'),
|
|
11
|
+
'eval-file': () => require('../lib/commands/eval'),
|
|
12
|
+
reload: () => require('../lib/commands/reload'),
|
|
13
|
+
navigate: () => require('../lib/commands/navigate'),
|
|
14
|
+
init: () => require('../lib/commands/init'),
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
const HELP = `cdp-cli v${version} — Browser DevTools bridge for AI coding assistants
|
|
18
|
+
|
|
19
|
+
Commands:
|
|
20
|
+
launch Start browser with CDP enabled
|
|
21
|
+
targets List debuggable pages
|
|
22
|
+
eval <id> <js> Evaluate JS in page context
|
|
23
|
+
eval-file <id> <f> Evaluate JS file in page context
|
|
24
|
+
reload [id] Reload page(s)
|
|
25
|
+
navigate <id> <url> Navigate to URL
|
|
26
|
+
init [--agent] Generate .cdprc.json (--agent: inject AI assistant reference)
|
|
27
|
+
|
|
28
|
+
Examples:
|
|
29
|
+
cdp-cli launch
|
|
30
|
+
cdp-cli targets
|
|
31
|
+
cdp-cli eval 8FEE "document.querySelectorAll('.item').length"
|
|
32
|
+
cdp-cli reload
|
|
33
|
+
|
|
34
|
+
Config: .cdprc.json (searched upward from cwd)
|
|
35
|
+
Flags: --port, --browser, --timeout, --human, --extension, --help, --version`;
|
|
36
|
+
|
|
37
|
+
function main() {
|
|
38
|
+
const args = process.argv.slice(2);
|
|
39
|
+
|
|
40
|
+
if (args.includes('--version') || args.includes('-v')) {
|
|
41
|
+
console.log(version);
|
|
42
|
+
return;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
if (args.length === 0 || args.includes('--help') || args.includes('-h')) {
|
|
46
|
+
console.log(HELP);
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const cmd = args[0];
|
|
51
|
+
const loader = COMMANDS[cmd];
|
|
52
|
+
|
|
53
|
+
if (!loader) {
|
|
54
|
+
console.error(JSON.stringify({ error: `Unknown command: ${cmd}. Run cdp-cli --help for usage.` }));
|
|
55
|
+
process.exit(1);
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
const mod = loader();
|
|
59
|
+
// Pass remaining args (after command name)
|
|
60
|
+
mod.run(args.slice(1)).catch(err => {
|
|
61
|
+
console.error(JSON.stringify({ error: err.message }));
|
|
62
|
+
process.exit(1);
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
main();
|