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.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 n98/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`
composer	Commands for managing Composer-related tasks and package deployment.	`composer:redeploy-base-packages`
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.

n98 / magerun2

Maintainers

Package info

Statistics

Security