|
| 1 | +# TAGLINE |
| 2 | + |
| 3 | +CLI for letting AI coding agents capture screenshots of browser tabs |
| 4 | + |
| 5 | +# TLDR |
| 6 | + |
| 7 | +**Start** the WebSocket daemon that the browser extension connects to |
| 8 | + |
| 9 | +```peeked start``` |
| 10 | + |
| 11 | +**List** currently tracked browser tab URLs |
| 12 | + |
| 13 | +```peeked list``` |
| 14 | + |
| 15 | +**Capture** a screenshot of the page at a given URL (extension must be connected) |
| 16 | + |
| 17 | +```peeked at http://localhost:3000``` |
| 18 | + |
| 19 | +**Check** server and extension connection status |
| 20 | + |
| 21 | +```peeked status``` |
| 22 | + |
| 23 | +**Stop** the WebSocket server |
| 24 | + |
| 25 | +```peeked stop``` |
| 26 | + |
| 27 | +# SYNOPSIS |
| 28 | + |
| 29 | +**peeked** _command_ [arguments] |
| 30 | + |
| 31 | +# COMMANDS |
| 32 | + |
| 33 | +**start** |
| 34 | + |
| 35 | +> Start the local WebSocket server (on port 7336) that receives screenshot requests and streams to the browser extension. Cleans previous images on start. |
| 36 | +
|
| 37 | +**list** |
| 38 | + |
| 39 | +> List all tracked open tab URLs reported by the connected browser extension. |
| 40 | +
|
| 41 | +**at** _url_ |
| 42 | + |
| 43 | +> Request a screenshot of the specified URL from the connected browser tab. Saves the JPEG to a temporary directory (e.g. `$TMPDIR/peek_cli/images/`). |
| 44 | +
|
| 45 | +**status** |
| 46 | + |
| 47 | +> Report whether the server is running and whether a browser extension is connected. |
| 48 | +
|
| 49 | +**stop** |
| 50 | + |
| 51 | +> Stop the running WebSocket server process. |
| 52 | +
|
| 53 | +# DESCRIPTION |
| 54 | + |
| 55 | +`peeked` is the command-line component of peek-cli. It lets AI coding agents (such as Claude Code, Codex, and others) obtain live screenshots of open browser tabs. |
| 56 | + |
| 57 | +The tool consists of a local WebSocket server started by `peeked start`. A companion Chrome extension connects to the server and forwards screenshots on demand. Agents issue commands through the CLI (or via agent skills/plugins) to list tabs and request captures. |
| 58 | + |
| 59 | +Screenshots are delivered as base64 and written locally by the CLI; the agent never directly accesses the browser or injects code. |
| 60 | + |
| 61 | +Installation: |
| 62 | + |
| 63 | +```bash |
| 64 | +npm i -g peeked |
| 65 | +``` |
| 66 | + |
| 67 | +A matching browser extension must also be installed from the Chrome Web Store. |
| 68 | + |
| 69 | +# CAVEATS |
| 70 | + |
| 71 | +Requires the official Peek CLI Chrome extension; without it the server has no tabs to report or capture from. |
| 72 | + |
| 73 | +The server binds only to localhost. You must explicitly start it on every machine/session before use. |
| 74 | + |
| 75 | +Screenshots are written to a per-user temp directory and are not automatically cleaned except on `start`. |
| 76 | + |
| 77 | +Error messages may refer to outdated command names in some versions (e.g. "peeked begin"). |
| 78 | + |
| 79 | +Only provides read-only screenshot capability; no navigation, input, or page manipulation is possible. |
| 80 | + |
| 81 | +# SEE ALSO |
| 82 | + |
| 83 | +[chrome](/man/chrome)(1) |
| 84 | + |
| 85 | +# RESOURCES |
| 86 | + |
| 87 | +```[Source code](https://github.com/puffinsoft/peek-cli)``` |
| 88 | + |
| 89 | +<!-- verified: 2026-07-06 --> |
0 commit comments