Installation

Follow these steps to install Viscribe on your WordPress site. You can download the plugin from WordPress.org, GitHub, or GitLab.

From the WordPress Dashboard (Recommended)

This is the simplest method for most users—no technical knowledge required.

1. Log in to your WordPress admin area.
2. Navigate to Plugins → Add New.
3. Search for "Viscribe".
4. Click "Install Now", then click "Activate".
5. Go to Settings → Viscribe (or Media → Viscribe).
6. Enter your Groq API key (the free version uses Groq's API — see how to get one below).
7. Click "Test Connection" to verify your setup.
8. Click "Save Changes" — Viscribe is now active!

Manual Upload

If you have the plugin ZIP file:

1. Download the latest version from WordPress.org or GitHub.
2. In your WordPress admin, go to Plugins → Add New → Upload Plugin.
3. Select the viscribe.zip file and click "Install Now".
4. Click "Activate Plugin".
5. Follow steps 5–8 from the dashboard installation above.

For Developers (CLI)

If you prefer managing your plugins via the command line:

cd wp-content/plugins/
git clone https://github.com/thaikolja/viscribe-wordpress-plugin.git viscribe
cd viscribe
composer install --no-dev --optimize-autoloader

After cloning and installing dependencies, activate the plugin via the WordPress admin or WP-CLI: wp plugin activate viscribe

Getting a Groq API Key

Viscribe uses Groq's Vision API to analyze your images. You'll need a free API key:

1. Visit the Groq Cloud Console.
2. Sign up for a free account (takes less than a minute).
3. Click "Create API Key".
4. Give your key a name (e.g., "My WordPress Site") and copy it.
5. Paste the key (starting with gsk_) into the Viscribe settings.

No Credit Card Required

Groq offers a generous free tier suitable for most WordPress users.

Verifying the Installation

To ensure everything is configured correctly:

1. Go to the Viscribe settings page.
2. Click the "Test Connection" button.
3. A success message confirms that your server can communicate with the AI.
4. Try it out: Upload a new image to your Media Library and watch as Viscribe automatically generates a descriptive filename.

If you encounter issues, verify that your API key is active and that your server supports outgoing HTTP requests.