Skip to content

underd0se/nutshell-summarizer-extension

Repository files navigation

Nutshell

light-mode

Enhance your search with AI-powered clarity. Nutshell distills the key information from any web page and presents it as a concise summary, right on your results page.

About The Project

Nutshell is a Chrome extension designed to combat information overload and save users time. It addresses the common problem where the answer to a search query is buried within a noisy, lengthy webpage. By leveraging Chrome's built-in, on-device AI, Nutshell provides summaries directly on the Google search results page, allowing users to quickly assess the content of a link without leaving the page.

Features

  • Fast AI Summaries: A "Nutshell" button appears next to each search result for summarization.
  • On-Device & Private: Uses the built-in Chrome Summarizer API, meaning all processing happens locally on your machine. Nothing is sent to the cloud.
  • Smart Content Extraction: A robust "reader mode" algorithm purifies webpage content by stripping out ads, navigation, footers, and other junk before sending it to the AI, dramatically improving summary quality.
  • Adaptive Theming: The UI automatically detects and matches Google's Light and Dark themes for a seamless, native feel.
  • Clear Progress Indicators: The button provides real-time feedback during the summarization process ("Downloading...", "Summarizing...").

Built With

  • JavaScript (ES6+)
  • HTML5
  • CSS3
  • Chrome Extension APIs
  • Google AI Studio
  • Chrome Built-in AI Summarizer API
  • Visual Studio Code
  • Github CoPilot

Installation and Testing Instructions

Installation:

  1. Download the .zip file from here or from the Releases page.
  2. Unpack the .zip file into a local folder.
  3. Open a Chromium browser (like Chrome) and navigate to chrome://extensions.
  4. Enable "Developer mode" using the toggle in the top-right corner.
  5. Click the "Load unpacked" button and select the folder where you unpacked the files.

Functionality Testing:

  1. Go to google.com and perform any search query (e.g., how to carve a pumpkin for halloween)
  2. On the search results page, find a result and click the "Nutshell" button that appears next to it.
  3. Observe the button's progress indicator.
  4. A modal will appear with a concise, AI-generated summary.
  5. Test the "Copy" and "Retry" buttons in the modal.
  6. Change the Google Search theme between Light and Dark mode (via Google's settings) to verify that the extension's UI automatically adapts.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Icon Attribution

Nut icons created by Freepik - Flaticon

Legal

Google Chrome™, Google Chrome Extensions™, Google Web Search™, Google AI Studio™, and Gemini™ are trademarks of Google LLC.

Visual Studio Code, VS Code, and the Visual Studio Code icon are trademarks of Microsoft Corporation.