Skip to content

dorser/vibemonkey

Repository files navigation

VibeMonkey Logo

VibeMonkey

VibeMonkey is a Chrome extension that acts as your AI companion for generating userscripts on the fly. Simply describe a visual change you want to make to a webpage, and VibeMonkey will generate a Tampermonkey/Greasemonkey script to accomplish it.

Features

  • AI-Powered Script Generation: Uses Google's Gemini models to understand your requests and generate high-quality userscripts.
  • Context-Aware: Analyzes the current page's structure to create robust and effective scripts.
  • Side Panel UI: An easy-to-use interface that lives in your browser's side panel.
  • Secure: Your API key is stored locally and is never exposed.
  • Customizable: Choose the Gemini model that best suits your needs.

Installation

  1. Clone the repository:
    git clone https://github.com/your-username/vibemonkey.git
  2. Install dependencies:
    cd vibemonkey
    npm install
  3. Build the extension:
    npm run build
  4. Load the extension in Chrome:
    • Open Chrome and navigate to chrome://extensions.
    • Enable "Developer mode" in the top right corner.
    • Click "Load unpacked".
    • Select the vibemonkey directory.

Usage

  1. Set your API Key:
    • Click the VibeMonkey icon in the Chrome toolbar.
    • Click "Settings".
    • Enter your Google AI API key and choose a model.
    • Click "Save".
  2. Generate a Script:
    • Open the webpage you want to modify.
    • Click the VibeMonkey icon and select "Open Sidebar".
    • In the sidebar, describe the change you want to make (e.g., "Change the background color of the header to blue").
    • Click "Generate Script".
  3. Use the Script:
    • The generated script will appear in the result area.
    • You can Copy it to your clipboard or Save it as a .user.js file to be used with a userscript manager like Tampermonkey.

Development

This project uses webpack to bundle the JavaScript files. To watch for changes and automatically rebuild during development, run:

npm run watch

This project is experimental. Always review generated scripts before executing them.

About

AI companion for generating userscripts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published