Mage

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.

Benefits of Using Mage

• Easy Installation of Magento: install any version and distribution.
• Easier commands: Mage introduces shorter aliases for common bin/magento commands, saving you keystrokes.
• Custom functions: Mage offers helper commands like reindex and purge for specific tasks.
• Open stores quickly: Open your default store or specific store views with mage open.
• Efficient development: The watch command automates cache cleaning on file changes, improving your workflow.
• Easier patch creation: create patches only with a few arguments.

Installation

Download the script:

wget https://raw.githubusercontent.com/GrimLink/mage/main/mage && chmod +x mage

Alternatively, use curl:

curl -O https://raw.githubusercontent.com/GrimLink/mage/main/mage && chmod +x mage

Available Commands

For a complete list of commands, run mage help or view the src/_info.sh source.

Here are some highlights of what Mage can do:

Setup & Management

• mage create: Quickly scaffold and install a new Magento 2 project.
• mage nuke: Permanently delete the local Magento project (Database, Environment, Files).
• mage add [PKG|GIT_URL]: An enhanced composer require that also accepts raw git repository URLs.
• mage outdated: Easily view all direct outdated composer dependencies.

Store & Theme Development

• mage new store [url|prefix]: Programmatically create a new store view and configure its base URLs and routing (e.g., mage new store luma or mage new store b2b.example.test).
• mage new patch: Create a composer patch with ease.
• mage set mage-os: Easily replace the standard Magento 2 distro with the Mage-OS distro.

Daily Workflow

• mage open [storeview]: Open your default store or a specific store based on the storeview name. Use admin instead of storeview to open the admin panel.
• mage watch: A shortcut for Mage-OS Cache Clean that monitors Magento 2 file changes and clears only the affected cache automatically.
• mage purge: Clears all static generated files and caches. Useful for troubleshooting or forcing a hard reload.
• mage run [action]: Runs n98-magerun2 commands.

Note:

• mage run requires the n98-magerun2 module
• Commands with "hyva" require a Hyvä license or GitLab access
• mage watch requires the Mage-OS Cache Clean module
• set theme and set hyva requires the Yireo_ThemeCommands module

Supported Platforms

Mage works without additional configuration on:

• macOS
• Most Linux platforms
• Laravel Valet
• Warden: Supported with thanks to @tdgroot

Contributing

We welcome contributions to Mage! Fork the repository, make your changes, and submit a pull request.

License

Mage is licensed under the MIT License. See the LICENSE file for details.