NutEgg icon NutEgg Docs

Overview & Core Concepts

NutEgg is a local-first system designed to bridge the gap between passive web browsing and active knowledge curation in Obsidian.

The Metaphor

NutEgg structures your information flow using a simple three-part metaphor:

💡 Why NutEgg Exists

Most web clippers dump raw articles into your vault, creating an unorganized graveyard of unread bookmarks. NutEgg checks novelty against your existing knowledge tree upfront, so you immediately know if an article is worth your time or if it's just repeating concepts you already know.

System Architecture

NutEgg consists of two decoupled components that communicate locally:

  1. Chrome Extension: Lives in Chrome's side panel. Interacts with the active tab, extracts text and video transcripts, and displays AI summaries and chapter maps.
  2. Obsidian Plugin: Runs a lightweight HTTP server on 127.0.0.1:27123. Connects to your chosen AI provider using your own API key, reads your vault's _index.md, and saves files directly to disk.
Chrome Extension (Side Panel)
         │
         │  HTTP /analyze + /confirm (127.0.0.1:27123)
         ▼
Obsidian Plugin (Local Server)
         ├── Evaluates against vault/nutegg/_index.md
         ├── Queries AI Provider (Gemini / Claude / OpenAI / etc.)
         └── Writes to vault/nutegg/_raw/ and vault/nutegg/<egg>.md

Quick Start Roadmap

  1. Install and configure the Obsidian Plugin with your AI API key.
  2. Install the Chrome Extension.
  3. Define your first knowledge topics in _index.md and start hatching!