n98 / magerun2
Tools for managing Magento projects and installations
Installs: 239 527
Dependents: 5
Suggesters: 0
Security: 0
Stars: 901
Watchers: 40
Forks: 226
Open Issues: 33
Requires
- php: ^8.0
- ext-dom: *
- ext-iconv: *
- ext-json: *
- ext-pdo: *
- ext-posix: *
- ext-simplexml: *
- ext-zip: *
- dflydev/dot-access-data: ^3.0
- fakerphp/faker: ~1.16
- laminas/laminas-filter: ^2.12
- n98/junit-xml: ~1.0
- psr/container: ~1.1.2
- psr/log: ^2.0
- psy/psysh: ~0.7
- rmccue/requests: ^2.0
- symfony/console: ^6.4
- symfony/event-dispatcher: ^6.4
- symfony/finder: ^6.4
- symfony/process: ^6.4
- symfony/validator: ^6.4
- symfony/yaml: ^6.4
- twig/twig: ~3.4
Requires (Dev)
- bamarni/symfony-console-autocomplete: ^1.2.0
- captainhook/captainhook: ^5.3
- friendsofphp/php-cs-fixer: ^3.8
- mikey179/vfsstream: ^1.6
- phpstan/phpstan: ^2.0.1
- phpunit/phpunit: ^9
- roave/security-advisories: dev-master
- seld/phar-utils: ~1.2.0
Suggests
- n98/magerun2-dist: Deploys only the phar file. Use this to prevent dependency conflicts.
- dev-develop
- 9.0.0-alpha3
- 9.0.0-alpha2
- 9.0.0-alpha1
- 8.1.1
- 8.1.0
- 8.0.0
- 7.5.0
- 7.4.0
- 7.3.1
- 7.3.0
- 7.2.0
- 7.1.0
- 7.0.3
- 7.0.2
- 7.0.1
- 7.0.0
- 6.1.1
- 6.1.0
- 6.0.1
- 6.0.0
- 5.2.0
- 5.1.0
- 5.0.2
- 5.0.1
- 5.0.0
- 4.9.1
- 4.9.0
- 4.8.0
- 4.7.0
- 4.6.1
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.4
- 4.0.3
- 4.0.2
- 4.0.1
- 4.0.0
- 3.2.0
- 3.1.0
- 3.0.10
- 3.0.9
- 3.0.8
- 3.0.7
- 3.0.6
- 3.0.5
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.0
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.17
- 1.1.16
- 1.1.15
- 1.1.14
- 1.1.13
- 1.1.12
- 1.1.11
- 1.1.10
- 1.1.9
- 1.1.8
- 1.1.7
- 1.1.6
- 1.1.5
- 1.1.4
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.0
- dev-docs/add-dev-keep-calm-command
- dev-feature/improve-make-module-command
- dev-feature/499-keep-calm-command
- dev-feature/bearbeitungsaufgabe-für-issue-+499
- dev-feature/add-dev-console-command-to-docs
- dev-feature/bearbeite-problem-+1678
- dev-feature/extend-documentation-for-compatibility-and-installation
- dev-feature/add-mage-os-1.2.0-to-test-suite
- dev-feature/db-commands-view-handling
- dev-deprecate-install-command
- dev-codex/bearbeite-issue-+1684
- dev-dependabot/composer/laminas/laminas-filter-3.1.0
- dev-dependabot/github_actions/sigstore/cosign-installer-3.9.0
- dev-fix/deploy-yml-linting
- dev-docs-fix-skip-root-check-description
- dev-feat/add-module-dir-option
- dev-docs-add-module-structure-tip
- dev-feature/organize-routes-docs
- dev-feature/improve-dep-detection-versions
- dev-add-config-commands-hint-with-links
- dev-fix/admin-user-list-joinleft
- dev-extend-admin-user-list-command
- dev-master
This package is auto-updated.
Last update: 2025-06-21 12:03:20 UTC
README
n98-magerun2 provides powerful CLI tools for Magento 2, Mage-OS, and Adobe Commerce.
- Official Documentation: https://netz98.github.io/n98-magerun2/
- Development Branch:
develop
- Supported Magento: Magento 2 only (Magento 1/OpenMage tool here)
Quick Start
Download the PHAR file
curl -sS -O https://files.magerun.net/n98-magerun2.phar
curl -sS -o n98-magerun2-latest.phar.sha256 https://files.magerun.net/sha256.php?file=n98-magerun2.phar
shasum -a 256 -c n98-magerun2.phar.sha256
Install dist package
The dist package installs the n98-magerun2 PHAR file directly in your project.
composer require netz98/magerun2-dist
Run the PHAR file
You can run the PHAR file directly from the command line:
./n98-magerun2.phar
Build from source
- Clone the repository:
git clone https://github.com/netz98/n98-magerun2.git cd n98-magerun2
- Install dependencies:
composer install
- Build the PHAR:
./build.sh
Full Documentation
For full installation, usage, development, and contribution guidelines, please visit the official documentation.
Category/Namespace | Description | Example Commands |
---|---|---|
admin | Commands for managing Magento admin user accounts and related settings. | admin:user:list , admin:user:create , admin:user:change-password , admin:notifications |
cache | Commands for interacting with and managing Magento's various cache systems. | cache:clean , cache:disable , cache:enable , cache:flush , cache:list |
config | Commands for managing Magento store configurations and environment settings. | config:store:get , config:store:set , config:env:set , config:search |
customer | Commands for managing Magento customer accounts. | customer:create , customer:list , customer:info , customer:change-password |
db | Commands for database operations such as dumps, imports, and queries. | db:dump , db:import , db:query , db:create , db:info |
dev | Commands tailored for Magento developers, including code generation and debugging tools. | dev:module:create , dev:console , dev:translate:admin , dev:theme:list |
eav | Commands for managing EAV (Entity-Attribute-Value) attributes. | eav:attribute:list , eav:attribute:view , eav:attribute:remove |
giftcard | Commands for managing Magento gift cards. | giftcard:pool:generate , giftcard:create , giftcard:info , giftcard:remove |
generation | Commands related to Magento's code generation processes. | generation:flush |
index | Commands for managing Magento's indexers. | index:list , index:trigger:recreate |
install | Command for installing Magento. | installer |
integration | Command for integrations to Magento. | integration:list , integration:show , integration:delete |
magerun | Commands for working with n98-magerun2 config and internal tools. | magerun:config:info , magerun:config:dump |
routes | Commands for managing and viewing Magento routes. | routes:list |
script | Command for running sequences of n98-magerun2 commands from a file. | script |
sys | Commands for system-level information, checks, and maintenance tasks. | sys:info , sys:check , sys:maintenance , sys:cron:list , sys:store:list |
License
MIT License. See MIT-LICENSE.txt.