diff options
| author | TJ Dong <122852285+tj-dong@users.noreply.github.com> | 2026-06-07 15:22:23 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-06-07 18:22:23 -0400 |
| commit | 0f3ca97b13ef1aee7150269a776916bc4e65f41e (patch) | |
| tree | 55f65998a9448f9d05e16fc5ed63f04fc01ff18c /README.md | |
| parent | 341e2b3cebe41a4a14b00d83a84208971e0df7f5 (diff) | |
Clarify README installation instructions (#4)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 34 insertions, 10 deletions
@@ -15,34 +15,58 @@ You: [keeps coding — agent never asked you to log in] --- -## 60-second install +## 60-second install instruction + +To install pi-chrome, run the following command: ```bash pi install npm:pi-chrome ``` -Then in Pi: + +Then in Pi, run the next command, which will: + +1. Reveal the bundled browser-extension folder in Finder, and copy the folder path to your clipboard. +2. Pop open the chrome://extensions webpage in Chrome. + +In the Chrome Extensions page it opened, **YOU WILL NEED TO**: + +1. Turn on **developer mode** (top right). +2. Click the **load unpacked** button (top left). +3. Use **Cmd + Shift + G** (Mac) or **Ctrl + L** (Windows/Linux) to open the folder path field. +4. **Cmd + V** (Mac) or **Ctrl + V** (Windows/Linux) to paste the copied path and press Enter. +5. You're done with the chrome extensions page, and you can continue with the rest of the installation commands ```text /chrome onboard ``` -On macOS this opens `chrome://extensions`, reveals the bundled `browser-extension/` folder in Finder, and copies its path to your clipboard. In Chrome: **Developer mode** → **Load unpacked** → paste the path. Done. +Reload Pi so the newly installed package is actually loaded: + +```text +/reload +``` + -Verify, then authorize current Pi session from the terminal: +Verify the chrome connection: ```text /chrome doctor -/chrome authorize ``` +In the output, you just need to make sure the following line is present (It's okay if the other ones are still not checked): + + ✓ Chrome is connected (companion extension v0.15.36, responded in 11ms). +Lastly, authorize the current session by running: ```text -Performing Chrome bridge health check -pi-chrome v<version> -• Local bridge: mode=server, url=http://127.0.0.1:17318 -✓ Companion Chrome extension responding (ID: <chrome-extension-id>, ext v<version>) +/chrome authorize ``` +Run the following once more, and you should see all the lines checked: + +```text +/chrome doctor +``` --- ## Try this in 30 seconds after install @@ -135,7 +159,7 @@ Agents can verify page state immediately instead of blindly retrying. ## What an agent gets -**19 tools**, grouped by job. Every one runs against your already-open tabs. +**21 tools**, grouped by job. Every one runs against your already-open tabs. | Category | Tools | | --------------- | ---------------------------------------------------------------------------------------------- | |
