Skip to content

INSTALL.md

Latest commit

 

History

History
119 lines (75 loc) · 3.16 KB

INSTALL.md

File metadata and controls

119 lines (75 loc) · 3.16 KB

Chrome Extension Installation Guide

There are two ways to install the Grok Auto Retry extension for Chrome. The quickest path is to use a release ZIP, while building locally (listed second) remains the recommended way if you want to inspect the source before loading it.

Option A: Install from a Release ZIP (Quick Start)

Prerequisites (Release ZIP)

  • Google Chrome or a Chromium-based browser that supports extensions
  • Ability to download files from GitHub Releases

Steps (Release ZIP)

  1. Download the packaged build:

    • Visit the GitHub Releases
    • Download the latest asset ending with -dist.zip

  2. Extract the ZIP:

    • Unzip the archive to a convenient location (e.g., ~/Downloads/grok-auto-retry-dist)

  3. Open the Chrome Extensions page:

    • Go to chrome://extensions/
    • Or click the puzzle icon → "Manage Extensions"

  4. Enable Developer Mode:

    • Toggle the "Developer mode" switch in the top-right corner

  5. Load the extracted build:

    • Click "Load unpacked"
    • Select the unzipped folder (it should contain the built manifest.json)
    • The extension should now appear in your extensions list

  6. Verify installation:

Option B (Recommended): Build Locally and Load Unpacked

Prerequisites (Local Build)

  • Node.js 18 or newer
  • npm (bundled with Node.js)
  • Git (optional, but makes cloning easier)
  • Google Chrome or a Chromium-based browser that supports extensions

Steps (Local Build)

  1. Install dependencies & build:

    cd extension
npm install
npm run build

  2. Open the Chrome Extensions page:

    • Go to chrome://extensions/
    • Or click the puzzle icon → "Manage Extensions"

  3. Enable Developer Mode:

    • Toggle the "Developer mode" switch in the top-right corner

  4. Load the local build:

    • Click "Load unpacked"
    • Select the extension/dist folder you just built

  5. Verify installation:

Appendix: Installing Node.js and npm

If you need to install Node.js (which includes npm), follow the instructions for your operating system:

  • macOS (Homebrew):

    brew update
brew install node

  • macOS / Windows / Linux (Official Installer):

    1. Visit https://nodejs.org/.
    2. Download the "LTS" installer for your platform.
    3. Run the installer and follow the prompts.
    4. Restart your terminal after installation so the new node and npm commands are available.

  • Windows (winget):

    winget install OpenJS.NodeJS.LTS

  • Linux (Debian/Ubuntu):

    sudo apt update
sudo apt install nodejs npm

After installation completes, verify the tools are available:

node --version
npm --version

Both commands should print version numbers (for example, v20.11.0 for Node.js).