MR
Mayur Rathi
@github
⭐ 34.1k GitHub stars

Eyeball

Eyeball是一款writing方向的AI技能,核心价值是Document analysis with inline source screenshots,可用于解决开发者在writing领域的实际问题,帮助用户提升效率、自动化重复任务或优化工作流。

Document analysis with inline source screenshots. When you ask Copilot to analyze a document, Eyeball generates a Word doc where every factual claim includes a highlighted screenshot from the source m

Last verified on: 2026-05-30
mkdir -p ./skills/eyeball && curl -sfL https://raw.githubusercontent.com/github/awesome-copilot/main/skills/eyeball/SKILL.md -o ./skills/eyeball/SKILL.md

Run in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).

Skill Content

# Eyeball


Analyze documents with visual proof. When activated, Eyeball produces a Word document on the user's Desktop where every factual assertion includes an inline screenshot from the source material with the cited text highlighted in yellow.


Activation


When the user invokes this skill (e.g., "use eyeball", "run eyeball on this", "eyeball this document"), respond with:


> **Eyeball is active.** I'll analyze the document and produce a Word doc with inline source screenshots so you can verify every claim with your own eyes.


Then follow the workflow below.


Supported Sources


- **Local files:** Word documents (.docx, .doc), PDFs (.pdf), RTF files

- **Web URLs:** Any publicly accessible web page


Tool Location


The Eyeball Python utility is located at:

text
<plugin_dir>/skills/eyeball/tools/eyeball.py

To find the actual path, run:

bash
find ~/.copilot/installed-plugins -name "eyeball.py" -path "*/eyeball/*" 2>/dev/null

If not found there, check the project directory or the user's home directory for the eyeball repo.


First-Run Setup


Before first use, check that dependencies are installed:


bash
python3 <path-to>/eyeball.py setup-check

If anything is missing, install the required dependencies:

bash
pip3 install pymupdf pillow python-docx playwright
python3 -m playwright install chromium

On Windows, also install pywin32 for Word automation:

bash
pip install pywin32

Workflow


Follow these steps exactly. The order matters.


Step 1: Read the source text


Before writing any analysis, extract and read the full text of the source document:


bash
python3 <path-to>/eyeball.py extract-text --source "<path-or-url>"

Read the output carefully. Identify actual section numbers, headings, page numbers, and key language.


**CRITICAL:** Do not skip this step. Do not write analysis based on assumptions about how the document is structured. Read the actual text.


Step 2: Write analysis with exact citations


For each point in your analysis, you must:


1. **Reference the correct section number as it appears in the document** (e.g., "Section 9" not "Section 8" because you assumed the numbering).

2. **Reference the correct page number** where the section appears in the extracted text.

3. **Select anchors that are verbatim phrases from the source** that directly support your claim.


Step 3: Select anchors correctly


This is the most important step. Anchors determine what gets highlighted in the screenshots.


**DO:**

- Use verbatim phrases from the source text that directly support your assertion

- Use multiple anchors to span the full range of text the reader should see

- Use specific, uncommon phrases that appear only where you intend


**DO NOT:**

- Use generic topic labels (e.g., "Confidentiality") that appear throughout the document

- Use section titles alone when they appear as cross-references elsewhere

- Use single common words that match in many places


**Examples:**


WRONG -- uses a generic topic label that matches everywhere:

json
{"anchors": ["User-Generated Content"], "target_page": 8}

RIGHT -- uses the specific language that supports the claim:

json
{"anchors": ["retain ownership", "Ownership of Content, Right to Post"], "target_page": 8}

WRONG -- section title appears as a cross-reference on earlier pages:

json
{"anchors": ["LIMITATION OF LIABILITY"]}

RIGHT -- includes the section number for precision, targets the correct page:

json
{"anchors": ["12. LIMITATION OF LIABILITY", "INDIRECT", "CONSEQUENTIAL"], "target_page": 13}

Step 4: Build the analysis document


Construct a JSON array of sections and call the build command:


bash
python3 <path-to>/eyeball.py build \
  --source "<path-or-url>" \
  --output ~/Desktop/<title>.docx \
  --title "Analysis Title" \
  --subtitle "Source description" \
  --sections '[
    {
      "heading": "1. Section Title",
      "analysis": "Your analysis text here. Reference Section X on page Y...",

🎯 Best For

  • Technical writers
  • API documentation teams
  • Developers scaffolding new projects
  • Prototype builders
  • Data analysts

💡 Use Cases

  • Generating JSDoc/TSDoc comments
  • Writing README files for new projects
  • Bootstrapping React components
  • Creating API route handlers

📖 How to Use This Skill

  1. 1

    Install the Skill

    Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.

  2. 2

    Load into Your AI Assistant

    Open Claude or GitHub Copilot and reference the skill. Paste the SKILL.md content or use the system prompt tab.

  3. 3

    Apply Eyeball to Your Work

    Provide context for your task — paste source material, describe your audience, or share existing work to guide the AI.

  4. 4

    Review and Refine

    Edit the AI output for accuracy, tone, and completeness. Add human insight where the AI lacks context.

❓ Frequently Asked Questions

Does it follow my documentation style?

Most documentation skills respect existing style. Provide a style guide or example in your prompt.

Can I customize the generated output?

Yes — modify the skill's prompt instructions to match your project conventions and coding style.

Can this connect to my database directly?

Most data skills accept CSV or JSON input. Database connectors are listed in the Works With section.

Can Eyeball maintain my brand voice?

Yes — provide style guides or example content in your prompt for consistent brand-aligned output.

How do I install Eyeball?

Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/eyeball/SKILL.md, ready to use.

⚠️ Common Mistakes to Avoid

Auto-generating without reviewing

AI documentation can contain inaccuracies. Always verify technical accuracy.

Using generated code without understanding

Understand what generated code does before shipping it to production.

Not validating data quality

AI analysis is only as good as your input data. Profile and clean data before analysis.

Publishing unedited drafts

AI writing needs human editing for facts, flow, and authentic voice.

🔗 Related Skills