You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update eyeball plugin with bug fixes and Windows support
- Fix resource leaks (pdf_doc closed in finally blocks)
- Fix Windows Word COM automation (DispatchEx, proper cleanup)
- Fix converter order (Word before LibreOffice on Windows)
- Add source file existence checks with clear errors
- Fix Playwright cache detection for all platforms
- Fix setup.sh error handling (pipefail)
- Fix AppleScript path injection
- Fix highlight padding scaling with DPI
- Add pywin32 as Windows dependency
- Update README with Windows setup instructions
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy file name to clipboardExpand all lines: plugins/eyeball/README.md
+55-17Lines changed: 55 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,41 +1,77 @@
1
-
# Eyeball
1
+
A tool to help verify AI statements, without (or at least with fewer) context switching pains.
2
2
3
3
When AI analyzes a document and tells you "Section 10 requires mutual indemnification," how do you know Section 10 actually says that? Eyeball lets you see for yourself.
4
4
5
-
Eyeball is a Copilot CLI plugin that generates document analyses as Word files with inline screenshots from the source material. Every factual claim in the analysis includes a highlighted excerpt from the original document, so you can verify each assertion without switching between files or hunting for the right page.
5
+
This is a Copilot CLI plugin that generates document analyses as Word files with inline screenshots of relevant portions from the source material. Every factual claim in the analysis includes a highlighted excerpt from the original document, so you can verify each assertion without switching between files or hunting for the right page.
6
6
7
7
## What it does
8
8
9
9
You give Copilot a document (Word file, PDF, or web URL) and ask it to analyze something specific. Eyeball reads the source, writes the analysis, and for each claim, captures a screenshot of the relevant section from the original document with the cited text highlighted in yellow. The output is a Word document on your Desktop with analysis text and source screenshots interleaved.
10
10
11
11
If the analysis says "Section 9.3 allows termination for cause with a 30-day cure period," the screenshot below it shows Section 9.3 from the actual document with that language highlighted. If the screenshot shows something different, the analysis is wrong and you can see it immediately.
12
12
13
-
## Prerequisites
13
+
## Installation
14
+
15
+
### Prerequisites
14
16
15
17
-[Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) installed and authenticated
16
18
- Python 3.8 or later
17
19
- One of the following for Word document support (PDFs and web URLs work without these):
18
20
- Microsoft Word (macOS or Windows)
19
21
- LibreOffice (any platform)
20
22
21
-
## Setup
23
+
### Install the plugin
24
+
25
+
Point your CLI at this repo and ask it to install the plugin for you, with this prompt:
26
+
27
+
```
28
+
Install the plugin at github.com/dvelton/eyeball for me.
29
+
```
30
+
31
+
Or:
22
32
23
-
After installing the plugin, install the Python dependencies:
33
+
Install via the Copilot CLI plugin system, or clone the repo:
This shows which source types are supported on your machine.
71
+
72
+
## How to use it
73
+
74
+
In a Copilot CLI conversation, tell it to use eyeball and what you want analyzed:
39
75
40
76
```
41
77
use eyeball on ~/Desktop/vendor-agreement.docx -- analyze the indemnification
@@ -51,15 +87,15 @@ developer-friendly aspects of these terms
51
87
use eyeball to analyze this NDA for non-compete provisions
52
88
```
53
89
54
-
Eyeball reads the source document, writes the analysis with exact section references, and generates a Word document on your Desktop with source screenshots inline.
90
+
Eyeball activates, reads the source document, writes the analysis with exact section references, and generates a Word document on your Desktop with source screenshots inline.
55
91
56
-
## Supported source types
92
+
## What it supports
57
93
58
94
| Source type | Requirements |
59
95
|---|---|
60
96
| PDF files | Python + PyMuPDF (included in setup) |
61
97
| Web pages | Python + Playwright + Chromium (included in setup) |
62
-
| Word documents (.docx) | Microsoft Word (macOS/Windows) or LibreOffice |
98
+
| Word documents (.docx) | Microsoft Word (macOS/Windows) or LibreOffice (any platform). On Windows, pywin32 is also required (included in setup). |
63
99
64
100
## How it works
65
101
@@ -74,14 +110,16 @@ The screenshots are dynamically sized: if a section of analysis references text
74
110
75
111
## Why screenshots instead of quoted text?
76
112
77
-
Quoted text is easy to fabricate. A model can generate a plausible-sounding quote that doesn't actually appear in the source, and without checking, you'd never know. Screenshots from the rendered source are harder to fake -- they show the actual formatting, layout, and surrounding context of the original document. You can see at a glance whether the highlighted text matches the claim, and the surrounding text provides context that a cherry-picked quote might omit.
113
+
In hallucination-sensitive contexts, sometimes we need to see receipts.
114
+
115
+
Quoted text is easy to fabricate. A model can generate a plausible-sounding quote that doesn't actually appear in the source, and without checking, you'd never know. Screenshots from the rendered source are harder to fake; they show the actual formatting, layout, and surrounding context of the original document. You can see at a glance whether the highlighted text matches the claim, and the surrounding text provides context that a cherry-picked quote might omit.
78
116
79
117
## Limitations
80
118
81
119
- Word document conversion requires Microsoft Word or LibreOffice. Without one of these, you can still use Eyeball with PDFs and web URLs.
82
-
- Text search is string-matching. If the source document uses unusual encoding, ligatures, or non-standard characters, some searches may not match.
120
+
- Text search is string-matching. If the source document uses unusual encoding, ligatures, or non-standard characters, some searches may not match. The skill instructions tell the AI to use verbatim phrases from the extracted text, which handles most cases.
83
121
- Web page rendering depends on Playwright and may not perfectly capture all dynamic content (e.g., content loaded by JavaScript after page load, content behind login walls).
84
-
- Screenshot quality depends on the source formatting. Dense multi-column layouts or very small text may produce less readable screenshots.
122
+
- Screenshot quality depends on the source formatting. Dense multi-column layouts or very small text may produce less readable screenshots. Increase the DPI setting if needed.
0 commit comments