eKomi CLI Commands for Magento 2
Looking for Magento 2 eKomi reviews integration? View the full Magento 2 eKomi reviews integration page to explore features, configuration options, and pricing.
Command line tools for managing eKomi Reviews. These commands are useful for manual operations, troubleshooting, and automation scripts.
Available Commands
shopreview:ekomi:sync
Synchronize reviews from eKomi for all configured accounts.
bin/magento shopreview:ekomi:sync [options]
Options:
| Option | Description |
|---|---|
--all |
Sync all historical reviews (full sync) |
--date_range=<range> |
Sync reviews from a specific time period |
Date Range Format:
1-11m- 1 to 11 months ago>=1y- 1 year or more ago
Examples:
# Sync recent reviews (default behavior)
bin/magento shopreview:ekomi:sync
# Full sync - all historical reviews
bin/magento shopreview:ekomi:sync --all
# Sync reviews from the last 3 months
bin/magento shopreview:ekomi:sync --date_range=3m
# Sync reviews from the last 6 months
bin/magento shopreview:ekomi:sync --date_range=6m
When to use:
- After initial setup to import existing reviews
- When reviews appear missing or out of sync
- To manually trigger a sync outside of cron schedule
shopreview:ekomi:import-new
Import only new reviews since the last sync.
bin/magento shopreview:ekomi:import-new
Examples:
# Import new reviews
bin/magento shopreview:ekomi:import-new
When to use:
- Quick sync of recent reviews
- When you don't need to re-import all historical data
- For incremental updates between full syncs
shopreview:ekomi:selftest
Run diagnostic tests to verify your configuration.
bin/magento shopreview:ekomi:selftest
Tests performed:
- PHP version compatibility
- Magento version compatibility
- Extension enabled status
- Cron configuration
- API connectivity
- Account credentials validation
Example output:
eKomi Reviews Self-Test Results
================================
[✓] PHP Version: 8.2.0 (OK)
[✓] Magento Version: 2.4.6 (OK)
[✓] Extension Status: Enabled
[✓] Cron Configuration: OK
[✓] API Connection: OK
[✓] Account 12345: Valid credentials
All tests passed!
When to use:
- After initial installation
- When troubleshooting issues
- Before contacting support
- As part of regular maintenance checks
Usage Tips
Running in Production
For production environments, consider:
# Run with specific memory limit if processing large amounts of data
php -d memory_limit=512M bin/magento shopreview:ekomi:sync --all
Automation
These commands can be integrated into deployment scripts or monitoring:
# Example: Post-deployment sync
bin/magento setup:upgrade
bin/magento cache:flush
bin/magento shopreview:ekomi:sync
Logging
Commands output progress to stdout. For logging:
# Save output to log file
bin/magento shopreview:ekomi:sync --all >> var/log/ekomi_manual_sync.log 2>&1
Need More Help?
Documentation:
- All Help Articles - Complete documentation overview
Support:
- Contact Support - Get help from our team
For a complete overview of features and configuration options, see Magento 2 eKomi reviews integration.