PHPackages                             minsar/module-admin-assistant - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Admin Panels](/categories/admin)
4. /
5. minsar/module-admin-assistant

ActiveMagento2-module[Admin Panels](/categories/admin)

minsar/module-admin-assistant
=============================

AI-powered explanations for Magento admin configuration - Minsar Admin Assistant

013PHP

Since Feb 9Pushed 3mo agoCompare

[ Source](https://github.com/minsarai/magento2-ai-admin-assistant)[ Packagist](https://packagist.org/packages/minsar/module-admin-assistant)[ RSS](/packages/minsar-module-admin-assistant/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

🤖 Magento 2 AI Admin Assistant
==============================

[](#-magento-2-ai-admin-assistant)

[![Latest Stable Version](https://camo.githubusercontent.com/34e695c6016bc2a934a96bed696e29b2f2ab562a7134d65a55d00653cd506bea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d312e302e302d626c75652e737667)](https://github.com/minsarai/magento2-ai-admin-assistant)[![License](https://camo.githubusercontent.com/8bb50fd2278f18fc326bf71f6e88ca8f884f72f179d3e555e20ed30157190d0d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d677265656e2e737667)](LICENSE)[![Magento](https://camo.githubusercontent.com/437cfc1b81efcfabfa3ed1558bbc4a626af17030913de1034d6601b268ef91a0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6d6167656e746f2d322e342b2d6f72616e67652e737667)](https://magento.com/)

Transform your Magento admin experience with AI-powered configuration help. Get instant, intelligent explanations for any configuration field with a simple click.

[![AI Admin Assistant Demo](docs/images/demo.svg)](docs/images/demo.svg)

✨ Features
----------

[](#-features)

- 🎯 **Smart Help Icons** - \[?\] icons appear next to every configuration field
- 🤖 **AI-Powered Explanations** - Real-time explanations using Google Gemini or OpenAI
- 📱 **Beautiful UI** - Professional modal popups with smooth loading animations
- 🔒 **Secure** - Encrypted API key storage with proper validation
- 📊 **Comprehensive Logging** - Full request/response logging for debugging
- 🆓 **Free Options** - Google Gemini integration with generous free tier
- ⚡ **Performance Optimized** - Minimal overhead, efficient code structure
- 🎨 **Admin-Friendly** - Seamlessly integrates with Magento's admin interface

🚀 Installation
--------------

[](#-installation)

### Via Composer (Recommended)

[](#via-composer-recommended)

```
composer require minsarai/magento2-ai-admin-assistant
php bin/magento module:enable Minsar_AdminAssistant
php bin/magento setup:upgrade
php bin/magento cache:flush
```

### Manual Installation

[](#manual-installation)

1. Download and extract to `app/code/Minsar/AdminAssistant/`
2. Run installation commands above

🔧 Configuration
---------------

[](#-configuration)

1. Navigate to **Stores → Configuration → Minsar → Admin Assistant**
2. Enable the module
3. Choose your AI provider:
    - **Google Gemini** (Free - No credit card required)
    - **OpenAI GPT-3.5** (Free $5 credit for new accounts)
4. Add your API key
5. Save configuration

### 🔑 Getting API Keys

[](#-getting-api-keys)

**Google Gemini (Recommended - Free):**

1. Visit [Google AI Studio](https://makersuite.google.com/)
2. Sign in with Google account
3. Click "Get API key"
4. Copy the key (starts with `AIza...`)

**OpenAI:**

1. Visit [OpenAI Platform](https://platform.openai.com/api-keys)
2. Create account and verify phone number
3. Generate API key
4. Copy the key (starts with `sk-...`)

🎯 How It Works
--------------

[](#-how-it-works)

1. **Click** any \[?\] icon next to configuration fields
2. **Loading** modal appears with smooth animation
3. **AI processes** your request in real-time
4. **Explanation** appears in a beautiful modal popup
5. **Learn** about Magento configurations instantly!

🛠️ Technical Details
--------------------

[](#️-technical-details)

### Requirements

[](#requirements)

- Magento 2.4.0 or higher
- PHP 8.1 or higher
- Valid AI provider API key

### Architecture

[](#architecture)

- **Clean MVC Structure** - Follows Magento best practices
- **Dependency Injection** - Proper service layer implementation
- **Interface-Based Design** - Easy to extend with new AI providers
- **Secure Configuration** - Encrypted API key storage
- **Comprehensive Logging** - Full audit trail

### File Structure

[](#file-structure)

```
app/code/Minsar/AdminAssistant/
├── Api/                    # Service contracts
├── Controller/             # Admin controllers
├── Model/                  # Business logic
│   ├── Ai/                # AI client implementations
│   ├── Config/            # Configuration sources
│   └── Log/               # Logging services
├── etc/                   # Module configuration
└── view/adminhtml/        # Admin templates

```

🔍 Troubleshooting
-----------------

[](#-troubleshooting)

### Common Issues

[](#common-issues)

**No help icons appearing:**

- Clear cache: `php bin/magento cache:flush`
- Check if module is enabled
- Refresh browser (Ctrl+F5)

**API errors:**

- Verify API key is correct
- Check logs: `var/log/minsar_adminassistant.log`
- Ensure API provider has credits/quota

**Network errors:**

- Check server internet connectivity
- Verify firewall allows outbound HTTPS

### Debug Mode

[](#debug-mode)

Enable detailed logging in module configuration for troubleshooting.

🔒 Privacy &amp; Security
------------------------

[](#-privacy--security)

### What We Send

[](#what-we-send)

- Configuration field names and labels
- Field descriptions and comments
- No customer data or PII

### What We Don't Send

[](#what-we-dont-send)

- Customer information
- Order data
- Payment details
- Store credentials
- Admin user data

### Security Features

[](#security-features)

- API keys stored encrypted
- Request rate limiting
- Comprehensive audit logging
- No automatic store changes

🤝 Contributing
--------------

[](#-contributing)

We welcome contributions! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

### Development Setup

[](#development-setup)

```
git clone https://github.com/minsarai/magento2-ai-admin-assistant.git
cd magento2-ai-admin-assistant
# Follow installation steps above
```

📄 License
---------

[](#-license)

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

🆘 Support
---------

[](#-support)

- 📧 **Email:**
- 🐛 **Issues:** [GitHub Issues](https://github.com/minsarai/magento2-ai-admin-assistant/issues)
- 📖 **Documentation:** [Wiki](https://github.com/minsarai/magento2-ai-admin-assistant/wiki)

🌟 Changelog
-----------

[](#-changelog)

### v1.0.0 (2026-01-22)

[](#v100-2026-01-22)

- ✨ Initial release
- 🤖 Google Gemini integration
- 🔧 OpenAI GPT-3.5 support
- 📱 Modal UI with loading states
- 🔒 Secure API key management
- 📊 Comprehensive logging

---

**Made with ❤️ by [minsarai](https://github.com/minsarai)**

*Transform your Magento admin experience with the power of AI!*

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance54

Moderate activity, may be stable

Popularity3

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/15244513c69853c34e091d97b366848b6aeaab35c24b13d586f5f5d2acd02976?d=identicon)[minsarai](/maintainers/minsarai)

---

Top Contributors

[![minsarai](https://avatars.githubusercontent.com/u/256527852?v=4)](https://github.com/minsarai "minsarai (4 commits)")

### Embed Badge

![Health badge](/badges/minsar-module-admin-assistant/health.svg)

```
[![Health](https://phpackages.com/badges/minsar-module-admin-assistant/health.svg)](https://phpackages.com/packages/minsar-module-admin-assistant)
```

###  Alternatives

[jeroennoten/laravel-adminlte

Easy AdminLTE integration with Laravel

4.0k4.8M43](/packages/jeroennoten-laravel-adminlte)[dmstr/yii2-adminlte-asset

AdminLTE backend theme asset bundle for Yii 2.0 Framework

1.1k1.8M67](/packages/dmstr-yii2-adminlte-asset)[dwij/laraadmin

LaraAdmin is a Open source Laravel Admin Panel / CMS which can be used as Admin Backend, Data Management Tool or CRM boilerplate for Laravel with features like CRUD Generation, Module Manager, Media, Menus, Backups and much more

1.6k68.7k](/packages/dwij-laraadmin)[filament/spatie-laravel-media-library-plugin

Filament support for `spatie/laravel-medialibrary`.

1764.8M125](/packages/filament-spatie-laravel-media-library-plugin)[bezhansalleh/filament-exceptions

A Simple &amp; Beautiful Pluggable Exception Viewer for FilamentPHP's Admin Panel

193195.9k13](/packages/bezhansalleh-filament-exceptions)[filament/infolists

Easily add beautiful read-only infolists to any Livewire component.

1220.8M36](/packages/filament-infolists)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
