Skip to content

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.

CommandEnvironmentFunctionalNotes
admin:adobe-ims:disableLocalDev
admin:adobe-ims:enableLocalDev
admin:adobe-ims:infoManager
admin:adobe-ims:statusManager
admin:user:createManager
admin:user:unlockManager
app:config:dumpManagerDev
app:config:importManager
app:config:statusManager
cache:cleanManager
cache:disableLocalDev
cache:enableLocalDev
cache:flushManager
cache:statusManager
catalog:images:resizeManager
catalog:product:attributes:cleanupManager
cms:wysiwyg:restrictManager
config:sensitive:setManager
config:setManager
config:showManager
cron:installLocalConsumers
cron:removeLocalConsumers
cron:runManagerConsumers
customer:hash:upgradeManager
deploy:mode:setInstaller
deploy:mode:showManager
dev:di:infoLocalDev
dev:email:newsletter-compatibility-checkLocalDev
dev:email:override-compatibility-checkLocalDev
dev:profiler:disableLocalDev
dev:profiler:enableLocalDev
dev:query-log:disableLocalDev
dev:query-log:enableLocalDev
dev:source-theme:deployLocalDev
dev:template-hints:disableLocalDev
dev:template-hints:enableLocalDev
dev:template-hints:statusLocalDev
dev:tests:runLocalDev
dev:urn-catalog:generateLocalDev
dev:xml:convertLocalDev
downloadable:domains:addLocalDev
downloadable:domains:removeLocalDev
downloadable:domains:showManager
encryption:data:list-re-encryptorsManager
encryption:data:re-encryptManager
encryption:key:changeManager
encryption:payment-data:updateManager
i18n:collect-phrasesLocalDev
i18n:packLocalDev
i18n:uninstallLocalDev
indexer:infoManager
indexer:reindexManager
indexer:resetManager
indexer:set-dimensions-modeManager
indexer:set-modeManager
indexer:show-dimensions-modeManager
indexer:show-modeManager
indexer:statusManager
info:adminuriManager
info:backups:listManager
info:currency:listManager
info:dependencies:show-frameworkLocal
info:dependencies:show-modulesLocal
info:dependencies:show-modules-circularLocal
info:language:listManager
info:timezone:listManager
inventory-geonames:importManager
inventory:reservation:create-compensationsManager
inventory:reservation:list-inconsistenciesManager
inventory:reservation:list-inconsistenciesManager
maintenance:allow-ipsLocalDev
maintenance:disableLocalDev
maintenance:enableLocalDev
maintenance:statusManager
media-content:syncManager
media-gallery:syncManager
module:config:statusLocal
module:disableLocalDev
module:enableLocalDev
module:statusManager
module:uninstallLocalDev
newrelic:create:deploy-markerManager
queue:consumers:listManager
queue:consumers:restartManagerConsumers
queue:consumers:startManagerConsumers
remote-storage:syncManager
sampledata:deployLocalDev
sampledata:removeLocalDev
sampledata:resetLocalDev
security:recaptcha:disable-for-user-forgot-passwordManager
security:recaptcha:disable-for-user-loginManager
security:tfa:google:set-secretManager
security:tfa:providersManager
security:tfa:resetManager
setup:backupManager
setup:config:setManager
setup:db-data:upgradeManagerUpgrade
setup:db-declaration:generate-patchManagerUpgrade
setup:db-declaration:generate-whitelistManagerUpgrade
setup:db-schema:upgradeManagerUpgrade
setup:db:statusManagerUpgrade
setup:di:compileDockerfile
setup:installInstaller
setup:performance:generate-fixturesLocalDev
setup:rollbackManager
setup:static-content:deployDockerfile
setup:store-config:setManager
setup:uninstallInstaller
setup:upgradeManagerUpgrade
store:listManager
store:website:listManager
theme:uninstallLocalDev
varnish:vcl:generateManager

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 the upgrader pod upon chart upgrade/install, you likely do not need to run this yourself. However, if you need to run setup: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 or config.php in your Dockerfile.