Skip to content

Select text on any webpage to get instant, simplified explanations.

Notifications You must be signed in to change notification settings

ari-abb/learning-copilot

Repository files navigation

Learning Copilot 🎓

Explain complex text simply.

Learning Copilot is a sleek but super useful browser extension that helps you understand any text that you are reading on the web. Simply select the text that you do not understand, and get an instant 1-click, simplified explanation powered by AI (Gemini, OpenAI, Claude, or Local LLMs).

Learning Copilot Demo

Features

  • Instant Explanations: Select text -> Click "Explain" on the tooltip -> Receive a fast explanation.
  • Context Aware: Analyses the surrounding text and page title for better accuracy.
  • Multi-Model Support: Pick from Gemini, OpenAI, Claude, or run completely offline with Local LLMs (via Ollama/LM Studio).
  • Custom Personas: Use our predefined settings or create your own custom Personas to change how the AI responds (e.g., "Explain like I'm 5", "Explain as if you are an angry Dad").
  • Privacy Focused: Your keys are stored locally. We don't track ANY of your usage. The only connection out of your PC is to the AI provider you pick.

Installation Guide

Method 1: Chrome Web Store (Coming Soon)

We are currently in the process of publishing to the Chrome Web Store. Once available, you can install it with one click.

Method 2: Manual Installation (Developer Mode)

You can install the extension locally right now by following these simple steps:

  1. Download the Extension:

    • Download the learning-copilot-0.8.0.zip file (from the Releases page or provided directly).
    • Unzip the file into a folder. You should see files like manifest.json, background.js, etc. inside.
  2. Open Chrome Extensions:

    • Open your browser (Chrome, Edge, Brave, etc.).
    • Navigate to chrome://extensions.
    • Or go to Menu (⋮) > Extensions > Manage Extensions.
  3. Enable Developer Mode:

    • Toggle the Developer mode switch in the top-right corner of the page.
  4. Load Unpacked Extension:

    • Click the Load unpacked button that appears in the top-left.
    • Select the folder where you unzipped the extension (the one containing manifest.json).
  5. Pin & Use:

    • The extension icon (magnifying glass) should appear in your toolbar.
    • Click the Puzzle Piece 🧩 icon and Pin "Learning Copilot" for easy access.

⚙️ Configuration

  1. Click the Learning Copilot icon in your toolbar.
  2. Go to the Settings tab.
  3. Select Provider: Choose your preferred AI provider (Gemini is recommended for free/high-speed usage).
  4. Enter API Key:
  5. Click Save Changes.

🛠️ Usage

  1. Highlight any text on a webpage.
  2. A small tooltip will appear near your selection.
  3. Click the icon to see the explanation.
  4. Use the dropdown in the tooltip to switch between Styles (Simple, Detailed, Bullet Points) or your own Custom Personas.

💻 Development

Value your privacy? Want to contribute?

  1. Clone the repo:
    git clone https://github.com/yourusername/learning-copilot.git
  2. Install dependencies:
    npm install
  3. Run in dev mode (hot-reload):
    npm run dev

Version: 0.8.0 (Beta) License: TBD

About

Select text on any webpage to get instant, simplified explanations.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages