bin/magento
Mappia is a powerful environment with more instances of Magento running concurrently than most systems you may have dealt with previously. As such, some of the behaviors of Magento's native commands change. This document outlines the various bin/magento
commands along with where you should probably be running them. This list isn't exhaustive and only covers the commands in out-of-box Magento. It does not currently include any commands from Adobe Commerce (the paid product).
WARNING
There are bin/magento
commands that are non-functional in Mappia clusters. They either do not operate at all or operate differently than you may expect due to the fact that you're only running the command on one of the many pods serving your storefront.
For your mental modeling, most commands that read information work as you're likely accustomed to, like:
bin/magento cache:status
bin/magento queue:consumer:list
However, commands that enable/disable features like:
bin/magento module:disable
bin/magento cache:disable
bin/magento cron:install
may either return errors or have no impact.
There are 4 parts of your development stack where you're likely going to be running bin/magento
when using Mappia.
- Dockerfiles
- Development environment on your local
- Installer (in the Mappia cluster)
- Manager (in the Mappia cluster)
the below provides context for where these commands should be run.
Command | Environment | Functional | Notes |
---|---|---|---|
admin:adobe-ims:disable | Local | ❌ | Dev |
admin:adobe-ims:enable | Local | ❌ | Dev |
admin:adobe-ims:info | Manager | ✅ | |
admin:adobe-ims:status | Manager | ✅ | |
admin:user:create | Manager | ✅ | |
admin:user:unlock | Manager | ✅ | |
app:config:dump | Manager | ❌ | Dev |
app:config:import | Manager | ✅ | |
app:config:status | Manager | ✅ | |
cache:clean | Manager | ✅ | |
cache:disable | Local | ❌ | Dev |
cache:enable | Local | ❌ | Dev |
cache:flush | Manager | ✅ | |
cache:status | Manager | ✅ | |
catalog:images:resize | Manager | ✅ | |
catalog:product:attributes:cleanup | Manager | ✅ | |
cms:wysiwyg:restrict | Manager | ✅ | |
config:sensitive:set | Manager | ✅ | |
config:set | Manager | ✅ | |
config:show | Manager | ✅ | |
cron:install | Local | ❌ | Consumers |
cron:remove | Local | ❌ | Consumers |
cron:run | Manager | ✅ | Consumers |
customer:hash:upgrade | Manager | ✅ | |
deploy:mode:set | Installer | ✅ | |
deploy:mode:show | Manager | ✅ | |
dev:di:info | Local | ❌ | Dev |
dev:email:newsletter-compatibility-check | Local | ❌ | Dev |
dev:email:override-compatibility-check | Local | ❌ | Dev |
dev:profiler:disable | Local | ❌ | Dev |
dev:profiler:enable | Local | ❌ | Dev |
dev:query-log:disable | Local | ❌ | Dev |
dev:query-log:enable | Local | ❌ | Dev |
dev:source-theme:deploy | Local | ❌ | Dev |
dev:template-hints:disable | Local | ❌ | Dev |
dev:template-hints:enable | Local | ❌ | Dev |
dev:template-hints:status | Local | ❌ | Dev |
dev:tests:run | Local | ❌ | Dev |
dev:urn-catalog:generate | Local | ❌ | Dev |
dev:xml:convert | Local | ❌ | Dev |
downloadable:domains:add | Local | ❌ | Dev |
downloadable:domains:remove | Local | ❌ | Dev |
downloadable:domains:show | Manager | ✅ | |
encryption:data:list-re-encryptors | Manager | ✅ | |
encryption:data:re-encrypt | Manager | ✅ | |
encryption:key:change | Manager | ✅ | |
encryption:payment-data:update | Manager | ✅ | |
i18n:collect-phrases | Local | ❌ | Dev |
i18n:pack | Local | ❌ | Dev |
i18n:uninstall | Local | ❌ | Dev |
indexer:info | Manager | ✅ | |
indexer:reindex | Manager | ✅ | |
indexer:reset | Manager | ✅ | |
indexer:set-dimensions-mode | Manager | ✅ | |
indexer:set-mode | Manager | ✅ | |
indexer:show-dimensions-mode | Manager | ✅ | |
indexer:show-mode | Manager | ✅ | |
indexer:status | Manager | ✅ | |
info:adminuri | Manager | ✅ | |
info:backups:list | Manager | ✅ | |
info:currency:list | Manager | ✅ | |
info:dependencies:show-framework | Local | ✅ | |
info:dependencies:show-modules | Local | ✅ | |
info:dependencies:show-modules-circular | Local | ✅ | |
info:language:list | Manager | ✅ | |
info:timezone:list | Manager | ✅ | |
inventory-geonames:import | Manager | ✅ | |
inventory:reservation:create-compensations | Manager | ✅ | |
inventory:reservation:list-inconsistencies | Manager | ✅ | |
inventory:reservation:list-inconsistencies | Manager | ✅ | |
maintenance:allow-ips | Local | ❌ | Dev |
maintenance:disable | Local | ❌ | Dev |
maintenance:enable | Local | ❌ | Dev |
maintenance:status | Manager | ✅ | |
media-content:sync | Manager | ✅ | |
media-gallery:sync | Manager | ✅ | |
module:config:status | Local | ✅ | |
module:disable | Local | ❌ | Dev |
module:enable | Local | ❌ | Dev |
module:status | Manager | ✅ | |
module:uninstall | Local | ❌ | Dev |
newrelic:create:deploy-marker | Manager | ✅ | |
queue:consumers:list | Manager | ✅ | |
queue:consumers:restart | Manager | ✅ | Consumers |
queue:consumers:start | Manager | ✅ | Consumers |
remote-storage:sync | Manager | ✅ | |
sampledata:deploy | Local | ❌ | Dev |
sampledata:remove | Local | ❌ | Dev |
sampledata:reset | Local | ❌ | Dev |
security:recaptcha:disable-for-user-forgot-password | Manager | ✅ | |
security:recaptcha:disable-for-user-login | Manager | ✅ | |
security:tfa:google:set-secret | Manager | ✅ | |
security:tfa:providers | Manager | ✅ | |
security:tfa:reset | Manager | ✅ | |
setup:backup | Manager | ✅ | |
setup:config:set | Manager | ✅ | |
setup:db-data:upgrade | Manager | ✅ | Upgrade |
setup:db-declaration:generate-patch | Manager | ✅ | Upgrade |
setup:db-declaration:generate-whitelist | Manager | ✅ | Upgrade |
setup:db-schema:upgrade | Manager | ✅ | Upgrade |
setup:db:status | Manager | ✅ | Upgrade |
setup:di:compile | Dockerfile | ❌ | |
setup:install | Installer | ✅ | |
setup:performance:generate-fixtures | Local | ❌ | Dev |
setup:rollback | Manager | ✅ | |
setup:static-content:deploy | Dockerfile | ❌ | |
setup:store-config:set | Manager | ✅ | |
setup:uninstall | Installer | ✅ | |
setup:upgrade | Manager | ✅ | Upgrade |
store:list | Manager | ✅ | |
store:website:list | Manager | ✅ | |
theme:uninstall | Local | ❌ | Dev |
varnish:vcl:generate | Manager | ✅ |
INFO
- Cron Mappia automatically deploys
cron
pods for you, you likely do not need to run this command yourself. - Consumers Mappia automatically deploys
consumer
pods for you, you likely do not need to run this command yourself. - Upgrade Mappia automatically runs
setup:upgrade
from theupgrader
pod upon chart upgrade/install, you likely do not need to run this yourself. However, if you need to runsetup:upgrade
yourself, you must run it with the--keep-generated
flag. - Dev These commands should be run in your development environment ahead of time and the results moved into your
env.php
orconfig.php
in your Dockerfile.