Mage is a simple tool built on top of bin/magento to enhance your Magento 2 development experience. It provides shortcuts and custom functions to save you time and effort.
- Easier commands: Mage introduces shorter aliases for common
bin/magentocommands, saving you keystrokes. - Custom functions: Mage offers helper commands like
reindexandpurgefor specific tasks. - Open stores quickly: Open your default store or specific store views with
mage open. - Efficient development: The
watchcommand automates cache cleaning on file changes, improving your workflow.
Download the script:
wget https://raw.githubusercontent.com/GrimLink/mage/main/mage && chmod +x mageAlternatively, use curl:
curl -O https://raw.githubusercontent.com/GrimLink/mage/main/mage && chmod +x mageFor a complete list, run mage help. Here are some highlights:
mage open [storeview]: Open your default store or a specific store based on thestoreviewname. You can also useadmininstead ofstoreview, to open the admin panel.mage watch: This alias for mage2tv Cache Clean monitors for Magento 2 file changes and clears only the affected cache, streamlining development.mage purge: This command clears all static generated files and caches, useful for troubleshooting or forcing a hard reload.mage set mage-os: Easily replace Magento2 distro with the Mage-OS distromage outdated: Show all direct outdated composer dependencies
Note:
mage runrequires the n98-magerun2 module- Commands with "hyva" require a Hyvä license or GitLab access
set themeandset hyvarequires the Yireo_ThemeCommands moduleset baldrrequires the Siteation Baldr Theme
Mage works without additional configuration on:
- macOS
- Most Linux platforms
- Laravel Valet
- Warden: Supported with thanks to @tdgroot
We welcome contributions to Mage! Fork the repository, make your changes, and submit a pull request.
Mage is licensed under the MIT License. See the LICENSE file for details.