Product Research
AI-powered competitive intelligence for WooCommerce products.
by Ahmad Wael · github.com/devwael/product-research · website
Install
No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:
wp plugin install https://github.com/devwael/product-research/archive/refs/heads/master.zipReadme
Product Research
AI-powered competitive intelligence for WooCommerce products.
Description
Product Research brings AI-powered competitive intelligence directly into your WooCommerce product editor. Analyze competitor pricing, variations, and features without leaving your WordPress dashboard. The plugin orchestrates web search, content extraction, and multi-provider AI analysis through a streamlined 4-step workflow — giving you actionable competitive insights in minutes.
✨ Features
- Multi-Step AI Analysis — 4-node workflow pipeline: Search → Extract → Analyze → Report
- Multi-Provider AI Support — Z.AI (OpenAI-compatible), Anthropic Claude, Google Gemini
- Web Search & Extraction — Tavily API for finding and extracting competitor data
- Search Preview — Review and filter search results before expensive analysis
- AI-Powered Recommendations — Strategic pricing and competitive recommendations
- Summary Dashboard — Price range, competitor count, key findings at a glance
- Competitor Cards — Expandable cards with pricing, variations, availability, features
- Product List Badges — Competitor count and price-position indicator in product list
- Export — CSV and PDF export of analysis reports
- Session Persistence — Resume analysis after page refresh or navigation
- Encrypted API Keys — AES-256-CBC encryption for all API credentials
- Configurable Limits — Cooldown, daily credit budget, capability-based access
📋 Requirements
| Requirement | Version |
|---|---|
| PHP | 8.1+ |
| WordPress | 6.0+ |
| WooCommerce | 7.0+ |
| Composer | 2.x |
🚀 Installation
- Clone the repository into your
wp-content/plugins/directory:cd wp-content/plugins git clone <repo-url> product-research - Install dependencies:
cd product-research composer install - Activate the plugin via Plugins → Installed Plugins in your WordPress admin.
- Configure your API keys — see Configuration below.
⚙️ Configuration
Navigate to WooCommerce → Product Research in your WordPress admin. The settings page has three sections:
- API Configuration — Select your AI provider (Z.AI, Anthropic Claude, or Google Gemini) and enter the corresponding API key. A Tavily API key is always required for web search and content extraction.
- Search & Analysis — Configure search depth, result limits, token budget, cache TTL, and domain exclusions to fine-tune the analysis pipeline.
- Security & Limits — Set the required WordPress capability for running analyses, configure cooldown periods between analyses, and set a daily credit budget.
All API keys are encrypted at rest using AES-256-CBC.
🔄 How It Works
- Open a WooCommerce product edit page.
- Click "Analyze Competitors" in the Product Research metabox.
- Review search results — deselect irrelevant URLs before proceeding.
- The plugin extracts and sanitizes competitor page content.
- AI analyzes each competitor for pricing, variations, and features.
- View the summary dashboard with expandable competitor cards.
- Export results as CSV or PDF.
🏗️ Architecture
Product Research is built on Neuron AI v2 with a modular architecture using PSR-4 autoloading and a lightweight PSR-11 dependency injection container.
The analysis pipeline flows through a 4-node workflow:
flowchart LR
A[StartEvent] --> B[SearchNode]
B --> C[SearchCompletedEvent]
C --> D[User Preview]
D --> E[ExtractNode]
E --> F[ExtractionCompletedEvent]
F --> G[AnalyzeNode]
G --> H[AnalysisCompletedEvent]
H --> I[ReportNode]
I --> J[StopEvent]
Module Overview
| Module | Description |
|---|---|
AI |
Agents, workflow nodes, structured output schemas |
API |
Tavily HTTP client, content sanitizer |
Admin |
Metabox, settings page, product list columns |
Ajax |
Research workflow AJAX endpoints |
Cache |
WordPress Transients-based caching |
Export |
CSV and PDF report export |
Report |
Custom post type and repository |
Security |
API key encryption, sanitized logging |
Tech stack: PHP 8.1+, Neuron AI v2, PSR-4 autoloading, lightweight PSR-11 DI container (12 services).
🤝 Contributing
- Fork the repository.
- Create a feature branch (
git checkout -b feature/your-feature). - Make your changes following these standards:
- WordPress PHP Coding Standards
- Strict typing:
declare(strict_types=1);in every PHP file - PSR-12 code style
- Descriptive commit messages
- Test your changes before submitting.
- Open a Pull Request against the
mainbranch.
📄 License
This project is licensed under the GPL-2.0-or-later license.
👤 Author
Ahmad Wael