NutEgg icon NutEgg Docs
← Back to Website GitHub

Overview & Core Concepts

NutEgg is a free, open-source Chrome extension that helps you decide what's worth reading—and understand it faster. It lives in Chrome's side panel and works on articles, threads, and YouTube videos. An optional Obsidian plugin turns what you read into a growing knowledge vault.

What You Get in Chrome

Install the extension, enter your AI API key (or point it at a local model) in Options, and NutEgg works right away—no account, no extra apps:

💡 Why NutEgg Exists

Too much of the web is padded videos, clickbait headlines, and AI-inflated articles. NutEgg answers the headline upfront and tells you honestly whether the content is worth your time—so you only spend attention where it pays off.

Optional: Add Obsidian

If you keep notes in Obsidian, install the companion plugin to connect the extension to your vault (127.0.0.1:27123). This adds 2-stage novelty evaluation against your vault's _index.md knowledge trees, delta synthesis, and automatic note archiving into nutegg/_raw/ and egg files. Everything in Chrome keeps working with or without it.

The Metaphor

With Obsidian connected, NutEgg structures your information flow using a simple three-part metaphor:

System Architecture

NutEgg has one core component and one optional companion:

  1. Chrome Extension: Lives in Chrome's side panel. Extracts text, comments, and video transcripts. In standalone mode or connected API mode, it executes AI calls locally using your configured provider and API key—ensuring your API keys never leave the browser.
  2. Obsidian Plugin (optional): Runs a local sync and coordinator service on 127.0.0.1:27123. Reads your vault's _index.md, manages prompt templates in _workflow/, and archives captured knowledge to disk. It supports:
    • Connected API Mode (Default): Coordinates knowledge matching, delegating AI inference to Chrome via an authenticated local WebSocket (keys never sent to Obsidian).
    • Shared Subscription Mode: Runs inference locally via ChatGPT sign-in (OAuth) or developer CLI tools (Codex, Claude Code, Antigravity) with zero API keys needed.
Chrome Extension (Side Panel)
 │
 ├── [Standalone Mode] Local AI Processing (Verdicts, Summaries, Mind Maps, Q&A)
 │
 └── [Connected Mode] HTTP + WebSocket (127.0.0.1:27123/execution/socket)
         │
         ▼
 Obsidian Plugin (Local Server & Coordinator)
         ├── Evaluates against vault/nutegg/_index.md & prompts in _workflow/
         ├── In API Mode: Delegates AI calls back to Chrome over WebSocket (keys stay in Chrome)
         ├── In Subscription Mode: Executes locally via CLI (Codex/Claude/agy) or ChatGPT OAuth
         └── Writes structured notes to vault/nutegg/_raw/ and <egg>.md

Quick Start Roadmap

  1. Watch the 🎬 NutEgg Promo Video for a 1-minute visual walkthrough.
  2. Install the Chrome Extension from Chrome Web Store and add your AI key in Options (see guide).
  3. Open the side panel on any article or YouTube video and click Analyze. That's it!
  4. Optional: Install the Obsidian Plugin (see guide) and define your first knowledge topics in _index.md to start hatching.