Getting Started

Getting Started

This guide will help you install and set up the Web Guide Chrome Extension.

Prerequisites

Before installing Web Guide, ensure you have:

• Browser: Chrome or Edge (version 88 or higher) with Manifest V3 support
• Microphone: Required for voice commands
• Audio Output: Required for voice responses
• Network Connection: For API access to Groq and ElevenLabs

Installation

Method 1: Developer Mode (Recommended for Testing)

1. Download the Extension

   • Download the latest release ZIP file from the Releases page
   • Extract the ZIP file to a folder on your computer

2. Open Chrome Extensions Page

   • Navigate to chrome://extensions in your Chrome browser
   • Alternatively, click the three-dot menu → More Tools → Extensions

3. Enable Developer Mode

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

4. Load the Extension

   • Click "Load unpacked" button at the top left
   • Select the extracted folder containing the extension files
   • The Web Guide icon should appear in your extensions toolbar

5. Grant Permissions

   • Pin the extension to your toolbar for easy access
   • When you first use the extension, grant microphone permissions
   • Enable the extension on the websites you want to use it on

6. Verify Installation

   • Click the Web Guide icon in your toolbar
   • The popup should appear with the voice input button

Method 2: Chrome Web Store (Coming Soon)

The extension will be available on the Chrome Web Store for one-click installation. Stay tuned for updates!

Initial Setup

Configuring API Keys

Important: The current version includes API keys in the code. For production use, you should:

1. Create your own API keys:

   • [Groq API Key](https://console.groq.com/)
   • [ElevenLabs API Key](https://elevenlabs.io/) (optional, for enhanced voice output)

2. Update the keys in config.js:

   const GROQ_API_KEY = 'your-groq-api-key-here';
   const ELEVENLABS_API_KEY = 'your-elevenlabs-api-key-here'; // optional

Testing Your Installation

1. Open a Test Website

   • Navigate to any website (e.g., Amazon, YouTube, Wikipedia)

2. Open the Extension

   • Click the Web Guide icon in your toolbar

3. Try a Voice Command

   • Click the microphone button
   • Say: "What is this page about?"
   • Wait for the response

4. Test Visual Guidance

   • Try: "Show me the search bar"
   • The extension should highlight and point to the search element

Permissions Explained

The extension requires the following permissions:

• activeTab: To interact with the current webpage
• scripting: To inject content scripts that analyze page content
• storage: To save your preferences and settings
• host_permissions (<all_urls>): To work on any website you visit
• Microphone: To capture voice commands (requested when first used)

All permissions are used solely for the extension's functionality and no data is collected or transmitted except to the AI APIs for processing your commands.

Next Steps

• Read the User Guide to learn how to use all features
• Check out Voice Commands Examples for what you can ask
• Review Technical Documentation if you want to understand how it works

Troubleshooting Installation

If you encounter issues during installation:

1. Extension doesn't load

   • Ensure all files are in the same folder
   • Check that manifest.json is present
   • Try refreshing the extensions page

2. No permissions prompt

   • Refresh the webpage after installing
   • Check browser settings for blocked permissions

3. Icon doesn't appear

   • Click the puzzle piece icon in Chrome toolbar
   • Pin the Web Guide extension

For more help, see the Troubleshooting page.

---

← Back to Home | Next: User Guide →