Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/code-forge-temple/scribe-pal

ScribePal is an Open Source intelligent browser extension that leverages AI to empower your web experience by providing contextual insights, efficient content summarization, and seamless interaction while you browse.
https://github.com/code-forge-temple/scribe-pal

ai ai-assistant browser-extension chatbot chrome-extension contextual-ai edge-extension firefox-extension large-language-models llm-integration local-ai local-llm manifest-v3 ollama open-source productivity-tool typescript web-assistant web-extension

Last synced: about 2 months ago
JSON representation

ScribePal is an Open Source intelligent browser extension that leverages AI to empower your web experience by providing contextual insights, efficient content summarization, and seamless interaction while you browse.

Awesome Lists containing this project

README 

          
# ScribePal



ScribePal is an Open Source intelligent browser extension that leverages AI to empower your web experience by providing contextual insights, efficient content summarization, and seamless interaction while you browse.



> ⭐️ **Love this project?** Please consider [starring the repository](https://github.com/code-forge-temple/scribe-pal) on GitHub and [supporting development](https://github.com/sponsors/code-forge-temple) to help me continue building amazing features!  



## Table of Contents



- [ScribePal](#scribepal)

    - [Table of Contents](#table-of-contents)

    - [Privacy](#privacy)

    - [Compatibility](#compatibility)

    - [Features](#features)

    - [Prerequisites](#prerequisites)

        - [Linux](#linux)

        - [Windows](#windows)

    - [Development](#development)

        - [Installation](#installation)

        - [Alternative Installation Options](#alternative-installation-options)

        - [Install via Browser Stores](#install-via-browser-stores)

        - [Download from Releases](#download-from-releases)

        - [Building](#building)

            - [I. For development](#i-for-development)

            - [II. For production](#ii-for-production)

        - [Linting](#linting)

        - [Installing in browser](#installing-in-browser)

    - [Usage](#usage)

    - [License](#license)

    - [✨ My Other Projects](#-my-other-projects)



## Privacy



ScribePal works with local Ollama models, ensuring that all AI processing and messaging is conducted within your local network. Your private data remains on your system and is never transmitted to external servers. This design provides you with full control over your information and guarantees that nobody outside your network has access to your data.



## Compatibility



It is compatible with all Chromium and Gecko-based browsers: Chrome, Vivaldi, Opera, Edge, Firefox, Brave etc.



## Features



- **AI-powered assistance:** Communicates with an AI service (using [ollama](https://www.npmjs.com/package/ollama)) to generate responses.

- **It is PRIVATE:** Because it communicates with a local (within your LAN) Ollama service and LLMs, all your information stays private.

- **Theming:** Supports light and dark themes.

- **Chat Interface:** A draggable chat box for sending and receiving messages.

- **Model Management:** Select, refresh, download, and delete models.

- **Advanced Capture Tools:** Options for capturing both text and images are available. Captured content is inserted directly into your chat using special tags (`@captured-text` for text and `@captured-image` for images).

- **Prompt Customization:** Adjust and customize prompts to instruct the AI model on how to generate responses.

- **File Attachments:** Upload files to the chat interface and reference them in discussions using the `@attached-files` tag.



## Prerequisites



Before installing ScribePal, ensure that you have Node Version Manager (nvm) installed. You can install nvm by following the instructions at [nvm-sh/nvm](https://github.com/nvm-sh/nvm#installing-and-updating). nvm helps you easily switch to the Node.js version specified in [`.nvmrc`](.nvmrc).



Also, ensure that the [Ollama](https://ollama.com) host is installed on your local machine or available on your LAN:



### Linux



1. Install Ollama on your host.

2. Edit the systemd service file by running:

    ```sh

    sudo nano /etc/systemd/system/ollama.service

    ```

3. Add the following environment variables in the `[Service]` section:

    ```

    Environment="OLLAMA_HOST=0.0.0.0"

    Environment="OLLAMA_ORIGINS=chrome-extension://*,moz-extension://*"

    ```

> [!NOTE]

> The `OLLAMA_HOST=0.0.0.0` setting is optional if the Ollama server is running on localhost and you do not need the Ollama server to be accessed from LAN.



4. Save the file, then reload and restart the service:

    ```sh

    sudo systemctl daemon-reload

    sudo systemctl restart ollama.service

    ```



### Windows



1. Install Ollama on your host.

2. On the machine running Ollama, set the environment variables:

    ```

    OLLAMA_HOST=0.0.0.0

    OLLAMA_ORIGINS=chrome-extension://*,moz-extension://*

    ```

   You can do this via the System Properties or using PowerShell.

> [!NOTE]

> The `OLLAMA_HOST=0.0.0.0` setting is optional if the Ollama server is running on localhost and you do not need the Ollama server to be accessed from LAN.



3. Restart Ollama app.



## Development



### Installation



1. Clone the repository:

    ```sh

    git clone https://github.com/code-forge-temple/scribe-pal.git

    cd scribe-pal

    ```



2. Set the Node.js version:

    - For Unix-based systems:

        ```sh

        nvm use

        ```

    - For Windows:

        ```sh

        nvm use $(cat .nvmrc)

        ```



3. Install dependencies:

    ```sh

    npm install

    ```



### Alternative Installation Options



If you're not a developer, you can choose one of the following methods:



### 1. Install via Browser Stores



  [![Chrome Store](./badges/chrome-add-on-badge.png)](https://chromewebstore.google.com/detail/godcjpkfkipmljclkgmohpookphckdfl?utm_source=github-repo)

  [![Edge Store](./badges/edge-add-on-badge.png)](https://microsoftedge.microsoft.com/addons/detail/scribepal/omffcjaihckmfdphencecfigafaoocmb)

  [![Firefox Add-on](./badges/firefox-add-on-badge.png)](https://addons.mozilla.org/en-US/firefox/addon/scribe-pal/)



> [!NOTE]

> Releases available in the browser stores might be slightly out of sync with the GitHub releases. This can be due to the review process, packaging delays, or manual submission requirements. For the most up-to-date version, please refer to the [Releases](https://github.com/code-forge-temple/scribe-pal/releases) page.



### 2. Download from Releases



Visit the [Releases](https://github.com/code-forge-temple/scribe-pal/releases) page to download the latest packages:



- For Chromium-based browsers, download `chrome.zip`.

- For Gecko-based browsers, download `firefox.zip`.



After downloading, unzip the package and [install](#installing) the extension manually.



### Building



#### I. For development



To build the project for development, run:



A. For Chromium-based browsers like Chrome, Vivaldi, Edge, Brave, Opera and others:

```sh

npm run dev:chrome

```



B. For Gecko-based browsers like Firefox, Waterfox, Pale Moon, and others:

```sh

npm run dev:firefox

```



#### II. For production



To build the project for production, run:



1. For Chromium-based browsers:

    ```sh

    npm run build:chrome

    ```



2. For Gecko-based browsers:

    ```sh

    npm run build:firefox

    ```



### Linting



To lint the project, run:

```sh

npm run lint

```



### Installing in browser



To install the the compiled extension, for:

- Chromium based browsers you need to go to 

    - `chrome://extensions/` (in Chrome browser)

    - `vivaldi://extensions/` (in Vivaldi browser)

    - `opera://extensions/`  (in Opera browser)

    - etc.



    and activate the `Developer Mode`, then `Load unpacked` then select `/dist/chrome` folder.



- For Gecko-based browsers, navigate to

    - `about:debugging#/runtime/this-firefox`

    - etc.



    and click on `Load Temporary Add-on…` then select `/dist/firefox` folder.



## Usage



1. **Open the Extension Popup:**

   - Once installed, click the extension icon in your browser’s toolbar.

   - The popup allows you to set your configuration options.



2. **Configure Settings:**

   - **Ollama Server URL:**  

     Enter the URL for your Ollama API server in the provided text field and click “Save”.

   - **Theme Selection:**  

     Use the toggle switch to activate the dark theme as desired.



3. **Launch the Chat Interface:**

   - Click “Show ScribePal chat” in the popup or press Ctrl+Shift+Y.

   - A responsive, draggable chat box will open on the active webpage.

   - Use the chat interface to send messages to the Ollama AI service, review conversation history, and manage models.

   - Additional features include capturing selected HTML content (that can be referenced in the discussion with `@captured-text` tag), capturing an image of an area on the page (that can be referenced in the discussion with `@captured-image` tag) for VISION LLMs, and customizing prompts (to instruct the loaded model on how to answer).

   - You can also attach files to the chat using the **Attach Files** button. Uploaded files can be referenced in the discussion using the `@attached-files` tag.



4. **Interacting with the Chat:**

   - Type your query in the chat input and press Enter or click the `Send` button.

   - The AI response is rendered below the input as markdown.

   - You can manage (delete or refresh) available Ollama models using the available controls in the model select dropdown.



Some short video tutorials on how to use the plugin:

1. Release 1.0.x:



[![IR7Jufc0zxo](https://img.youtube.com/vi/IR7Jufc0zxo/0.jpg)](https://www.youtube.com/watch?v=IR7Jufc0zxo)



2. Release 1.2.x:



[![m7pw6q5qgY0](https://img.youtube.com/vi/m7pw6q5qgY0/0.jpg)](https://www.youtube.com/watch?v=m7pw6q5qgY0)



## License

This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more details.



## ✨ My Other Projects



✦ [**Agentic Signal**](https://github.com/code-forge-temple/agentic-signal) – Visual AI agent workflow automation platform with local LLM integration - build intelligent workflows using drag-and-drop interface, no cloud dependencies required.  



✦ [**Local LLM NPC**](https://github.com/code-forge-temple/local-llm-npc) An interactive educational game built for the Google Gemma 3n Impact Challenge.  



✦ [**Circuit Sketcher - Obsidian Plugin**](https://github.com/code-forge-temple/circuit-sketcher-obsidian-plugin) - A plugin for Obsidian to draw circuits on a canvas.  



✦ [**Circuit Sketcher - Web App**](https://github.com/code-forge-temple/circuit-sketcher-app) - A web application to draw circuits on a canvas, based on circuit-sketcher-core.