README file from
Github🌰/🥚 NutEgg for Obsidian
Read less, hatch more, save time.
Capture web content, evaluate novelty with AI, and grow structured knowledge trees inside your Obsidian vault.
NutEgg is a two-part system designed to turn mindless browsing into an active, structured knowledge base:
- Chrome Extension — Grabs content from any webpage, tweet, or YouTube video (with transcripts). We call these raw captures nuts 🌰.
- Obsidian Plugin — Analyzes content with AI, evaluates novelty against your existing notes, and curates your knowledge base. We call these organized knowledge trees eggs 🥚.
💬 Feedback and ideas are always welcome via GitHub Issues or email at [email protected].
✨ Features
- Smart Content Extraction:
- YouTube: Full timestamped transcripts (including auto-generated captions) and clickable chapter maps.
- Twitter / X: Full threads, authors, media badges, and engagement metrics.
- Articles & Blogs: Medium, Substack, and generic web articles with ads and sidebars stripped.
- "Should You Read It?" Verdict:
- Delivers a 3-sentence executive summary.
- Gives a concrete recommendation on whether the content is worth your time based on your existing knowledge.
- Title Verdict (Anti-Clickbait):
- Directly answers the headline's question or hook in one sentence to save you time.
- Novelty Highlighting:
- Compares extracted entries against your existing Obsidian knowledge trees ("Eggs").
- Highlights ✨ New Insights in one view and identifies ✅ Already in Tree items so you don't waste time re-learning known concepts.
- Quick Capture Actions:
- 🥚 Hatch Egg: Extracts fresh insights and attaches them hierarchically into your structured knowledge trees in Obsidian.
- 🌰 Collect Nut: Saves a clean, raw markdown copy of the web page or video transcript into your vault archive (
nutegg/_raw/).
- Knowledge Tree Curation:
- Keeps knowledge organized by structuring new insights under matching concepts, filtering out duplicates, and maintaining clean topic trees.
What You Should Not Expect
- No magic: You won't get smarter just by clicking a button. Truly mastering knowledge still requires active reading, critical thinking, and practice.
- Built for fluff and clickbait, not structured textbooks: NutEgg is designed to save you time on bloated clickbait videos, repetitive blog posts, and AI-generated articles puffed up from a few simple ideas. It is not intended for deeply structured long-form material like textbooks or online courses—doing so will give you fragmented knowledge snippets rather than an organized learning system.
- Not tailored for entertainment: NutEgg is built for information density and insight extraction, not for summarizing comedy, movies, or entertainment videos (though you may make custom prompts that might work).
- Work in progress: Support for podcasts, PDF files, and additional formats is actively in development.
📦 Installation
Option 1: Obsidian Community Plugins (Recommended)
Install directly from the Obsidian Community Plugins Directory or search for NutEgg in Obsidian under Settings → Community Plugins → Browse.
Option 2: Manual Installation
- Download the latest release files (
main.js,manifest.json,styles.css) from the Releases page. - In your Obsidian vault, navigate to
.obsidian/plugins/(create the directory if it doesn't exist). - Create a folder named
nuteggand copymain.js,manifest.json, andstyles.cssinto it:your-vault/.obsidian/plugins/nutegg/ ├── main.js ├── manifest.json └── styles.css - In Obsidian, go to Settings → Community Plugins, reload installed plugins, and toggle NutEgg on.
Option 2: Using BRAT
- Install the BRAT plugin in Obsidian.
- Open Settings → BRAT → Add Beta plugin.
- Enter repository:
staff-000/nutegg-obsidian-release. - Enable NutEgg once installed.
🚀 Quick Start
- Enable the Plugin:
- In Obsidian, go to Settings → Community Plugins and toggle NutEgg on.
- Configure AI Provider:
- Open Settings → NutEgg.
- Choose your preferred provider (Google Gemini, Anthropic Claude, OpenAI, DeepSeek, etc.) and enter your API key.
- Local Sync Server (Zero Setup):
- NutEgg starts the local sync server automatically in the background on port
27123. - No extra setup required — you can verify the connection status anytime via the Chrome extension popup indicator.
- NutEgg starts the local sync server automatically in the background on port
- Set Up Knowledge Eggs:
- All knowledge files live in the
nutegg/folder in your vault. - Starter template files are generated automatically on first launch.
- Customize or add files to fit your personal knowledge areas:
nutegg/_index.md— (Required) Routing guide that maps topics and keywords to egg files.nutegg/invest_strategy.md— (Sample) Investment and portfolio knowledge tree.nutegg/psychology.md— (Sample) Cognitive biases and mental models.nutegg/ai_ml.md— (Sample) AI & Machine Learning knowledge tree.
- All knowledge files live in the
- Install Chrome Extension:
- Install the companion NutEgg from Chrome Web Store.
- Browse the web, click Analyze, and watch insights stream into Obsidian!
📂 Vault Structure
Everything managed by NutEgg lives cleanly within a single nutegg/ folder:
vault/
└── nutegg/
├── _raw/ # Captured nuts (raw web content with metadata)
│ └── 2026-09-04-14-30-youtube-dankoe-the-art-of-strategic-thinking.md
├── _index.md # Egg routing guide
├── ai_ml.md # Knowledge egg
├── psychology.md # Knowledge egg
└── productivity.md # Knowledge egg
🔗 Related Links
- Chrome Extension: NutEgg on Chrome Web Store
- Obsidian Plugin: NutEgg on Community Plugins
- Main Repository: staff-000/nutegg
📄 License
GNU General Public License v3.0