netz98 magerun CLI tools for Magento 2

The n98 magerun CLI Tools provides some handy tools to work with Magento / Mage-OS / Adobe Commerce from command line.

The swiss army knife for Magento developers, sysadmins and devops

Build Status

Latest Release
Development Branch

Development is done in develop branch.

This software is only running with Magento 2.

If you use Magento 1 please use another stable version (https://github.com/netz98/n98-magerun).

Compatibility

The tools will automatically be tested for multiple PHP versions. It's currently running in various Linux distributions and Mac OS X. Microsoft Windows is not fully supported (some Commands like db:dump or install are excluded).

We support the following Magento Versions:

• 2.4.x Open Source/Commerce
• 2.3.x Open Source/Commerce (last compatible n98-magerun2 version is v5.2.0)
• 2.2.x Open Source/Commerce (last compatible n98-magerun2 version is v3.2.0)

We support the following PHP Versions:

• PHP 8.2
• PHP 8.1
• PHP 7.4
• PHP 7.3 (last compatible version is v6.1.1)
• PHP 7.2 (last compatible version is v4.7.0)

Installation

There are three ways to install the tools:

Download and Install Phar File

Download the latest stable n98-magerun phar-file from the file-server:

wget https://files.magerun.net/n98-magerun2.phar

or if you prefer to use Curl:

curl -O https://files.magerun.net/n98-magerun2.phar

Verify the download by comparing the SHA256 checksum with the one on the website:

shasum -a256 n98-magerun2.phar

It is also possible to verify automatically:

curl -sS -O https://files.magerun.net/n98-magerun2-latest.phar
curl -sS -o n98-magerun2-latest.phar.sha256 https://files.magerun.net/sha256.php?file=n98-magerun2-latest.phar
shasum -a 256 -c n98-magerun2-latest.phar.sha256

If it shows the same checksum as on the website, you downloaded the file successfully.

Now you can make the phar-file executable:

chmod +x ./n98-magerun2.phar

The base-installation is now complete and you can verify it:

./n98-magerun2.phar --version

The command should execute successfully and show you the version number of N98-Magerun like:

n98-magerun2 version 4.8.0 by netz98 GmbH

You now have successfully installed Magerun! You can tailor the installation further like installing it system-wide and enable autocomplete - read on for more information about these and other features.

If you want to use the command system wide you can copy it to /usr/local/bin.

sudo cp ./n98-magerun2.phar /usr/local/bin/

Install the phar via Composer

We offer a special dist package to install the phar file via Composer. See https://packagist.org/packages/n98/magerun2-dist for more details. The main advantage of the dist package is that there are no package dependencies.

Install with Composer (Source Package) - not recommended

The installation via Composer is not recommended, because it's impossible to be compatible with all project and Magento core dependencies. Please use the phar file instead of the Composer version. We are not able to provide compatibility to all Magento versions anymore.

Update

There is a self-update command available. This works only for phar-distribution.

./n98-magerun2.phar self-update [--dry-run]

With --dry-run option it is possible to download and test the phar file without replacing the old one.

Autocompletion

Files for autocompletion with Magerun can be found inside the folder res/autocompletion, In the following some more information about a specific one (Bash), there are more (e.g. Fish, Zsh).

Bash

Bash completion is available pre-generated, all commands and their respective options are availble on tab. To get completion for an option type two dashes (--) and then tab.

To install the completion files, copy n98-magerun2.phar.bash to your bash compatdir folder for autocompletion.

On my Ubuntu system this can be done with the following command:

sudo cp res/autocompletion/bash/n98-magerun2.phar.bash /etc/bash_completion.d/

The concrete folder can be obtained via pkg-config:

pkg-config --variable=compatdir bash-completion

Detailed information is available in the bash-completions FAQ: https://github.com/scop/bash-completion#faq

Usage / Commands

NOTE There are more commands available as documented here. Please use the list command to see all.

All commands try to detect the current Magento root directory. If you have multiple Magento installations you must change your working directory to the preferred installation.

You can list all available commands by:

n98-magerun2.phar list

If you don't have the .phar file installed system wide you can call it with the PHP CLI interpreter:

php n98-magerun2.phar list

Global config parameters:

Open Shop in Browser

n98-magerun2.phar open-browser [store]

Customer Info

Loads basic customer info by email address.

n98-magerun2.phar  customer:info [email] [website]

Create customer

Creates a new customer/user for shop frontend.

n98-magerun2.phar  customer:create [email] [password] [firstname] [lastname] [website]

Example:

n98-magerun2.phar customer:create [email protected] password123 John Doe base

You can add additional any number of custom fields, example:

n98-magerun2.phar customer:create [email protected] passworD123 John Doe base taxvat DE12345678 prefix Mrs.

List Customers

List customers. The output is limited to 1000 (can be changed by overriding config). If search parameter is given the customers are filtered (searchs in firstname, lastname and email).

n98-magerun2.phar  customer:list [--format[="..."]] [search]

Change customer password

n98-magerun2.phar customer:change-password [email] [password] [website]

• Website parameter must only be given if more than one websites are available.

Create Customer Token for Webapi

n98-magerun2.phar customer:token:create <email>

Delete customer

n98-magerun2.phar customer:delete [-f|--force] [-a|--all] [-r|--range] [--fuzzy] [--id=ID] [--website=ID] [--email=EMAIL] [--firstname=STRING] [--lastname=STRING]

Examples:

n98-magerun2.phar customer:delete --id 1                     # Will delete customer with Id 1
n98-magerun2.phar customer:delete --fuzzy --email=test       # Will delete all customers with email like "%test%"
n98-magerun2.phar customer:delete --all                      # Will delete all customers
n98-magerun2.phar customer:delete --range                    # Will prompt for start and end Ids for batch deletion

Deletes customer(s) by given id or a combination of the website id and email or website id and firstname and lastname. In addition, you can delete a range of customer ids or delete all customers.

Magento Installer

• Downloads Composer (if not already installed)
• Downloads Magento 2.
• Tries to create database if it does not exist.
• Installs Magento sample data.
• Starts Magento installer
• Sets rewrite base in .htaccess file

Interactive installer:

n98-magerun2.phar install

Unattended installation:

n98-magerun2.phar install [--magentoVersion[="..."]] [--magentoVersionByName[="..."]] [--installationFolder[="..."]] [--dbHost[="..."]] [--dbUser[="..."]] [--dbPass[="..."]] [--dbName[="..."]] [--installSampleData[="..."]] [--useDefaultConfigParams[="..."]] [--baseUrl[="..."]] [--replaceHtaccessFile[="..."]]

Example of an unattended Magento CE 2.0.0.0 dev beta 1 installation:

n98-magerun2.phar install --dbHost="localhost" --dbUser="mydbuser" --dbPass="mysecret" --dbName="magentodb" --installSampleData=yes --useDefaultConfigParams=yes --magentoVersionByName="magento-ce-2.0.0.0-dev-beta1" --installationFolder="magento2" --baseUrl="http://magento2.localdomain/"

Additionally, with --noDownload option you can install Magento working copy already stored in --installationFolder on the given database.

Magento System Info

Provides infos like the edition, version or the configured cache backends, amount of data or installed packages.

n98-magerun2.phar sys:info

Options:

Magento Stores

Lists all store views.

n98-magerun2.phar sys:store:list [--format[="..."]]

Magento Websites

Lists all websites.

n98-magerun2.phar sys:website:list [--format[="..."]]

List Cronjobs

Lists all cronjobs defined in crontab.xml files.

n98-magerun2.phar sys:cron:list [--format[="..."]]

Run Cronjobs

Runs a cronjob by code.

n98-magerun2.phar sys:cron:run [job]

If no job argument is passed you can select a job from a list. See it in action: http://www.youtube.com/watch?v=QkzkLgrfNaM If option schedule is present, cron is not launched, but just scheduled immediately in magento crontab.

Kill a running job

n98-magerun2.phar sys:cron:kill [--timeout <seconds>] [job_code]

If no job is specified a interactive selection of all running jobs is shown. Jobs can only be killed if the process runs on the same machine as n98-magerun2.

Default timeout of a process kill is 5 seconds.

Cronjob History

Last executed cronjobs with status.

n98-magerun2.phar sys:cron:history [--format[="..."]] [--timezone[="..."]]

Create app/etc/env.php

Create env file interactively. If can also update existing files. To update a single value you can use the command config:env:set.

n98-magerun2.phar config:env:create

Set single value in env.php file

Set a single value in env.php by providing a key and an optional value. The command will save an empty string as default value if no value is set.

Sub-arrays in config.php can be specified by adding a "." character to every array.

n98-magerun2.phar config:env:set <key> [<value>]

You can also choose to provide a json text argument as value, by using the optional --input-format=json flag. This will allow you to add values that aren't a string but also other scalar types.

Examples:

n98-magerun2.phar config:env:set backend.frontName mybackend
n98-magerun2.phar config:env:set crypt.key bb5b0075303a9bb8e3d210a971674367
n98-magerun2.phar config:env:set session.redis.host 192.168.1.1
n98-magerun2.phar config:env:set 'x-frame-options' '*'

n98-magerun2.phar config:env:set --input-format=json queue.consumers_wait_for_messages 0
n98-magerun2.phar config:env:set --input-format=json directories.document_root_is_pub true
n98-magerun2.phar config:env:set --input-format=json cron_consumers_runner.consumers '["some.consumer", "some.other.consumer"]'

Delete key from env.php file

Remove a configuration from the env.php file by providing a key.

Sub-arrays in config.php can be specified by adding a "." character to every array.

n98-magerun2.phar config:env:delete <key>

Examples:

n98-magerun2.phar config:env:delete system
n98-magerun2.phar config:env:delete cache.frontend.default.backend
n98-magerun2.phar config:env:delete cache.frontend.default.backend_options

Show env.php settings

n98-magerun2.phar config:env:show [options] [<key>]

If no key is passed, the whole content of the file is displayed as table.

Examples:

n98-magerun2.phar config:env:show  # whole content
n98-magerun2.phar config:env:show backend.frontName
n98-magerun2.phar config:env:show --format=json
n98-magerun2.phar config:env:show --format=csv
n98-magerun2.phar config:env:show --format=xml

Set Store Config

n98-magerun2.phar config:store:set [--scope[="..."]] [--scope-id[="..."]] [--encrypt] path value

Arguments:

• path - The config path value The config value

Options:

Get Store Config

n98-magerun2.phar config:store:get [--scope="..."] [--scope-id="..."] [--decrypt] [--format[="..."]] [path]

Arguments:

• path - The config path

Options:

Help:

If path is not set, all available config items will be listed. path may contain wildcards (*)

Example:

n98-magerun2.phar config:store:get web/* --magerun-script

Delete Store Config

n98-magerun2.phar config:store:delete [--scope[="..."]] [--scope-id[="..."]] [--all] path

Arguments:

• path - The config path

Options:

Display ACL Tree

n98-magerun2.phar config:data:acl

Help:

Prints acl.xml data as table

Print Dependency Injection Config Data

n98-magerun2.phar config:data:di <type>

Arguments:

• type - Type (class)

Options:

Print MView Config

Print the data of all merged mview.xml files.

n98-magerun2.phar config:data:mview [options]

Options:

Print Indexer Config

Print the data of all merged indexer.xml files.

n98-magerun2.phar config:data:indexer [options]

Options:

List Magento cache status

n98-magerun2.phar cache:list

Clean Magento cache

Cleans expired cache entries.

If you would like to clean only one cache type:

n98-magerun2.phar cache:clean [code]

If you would like to clean multiple cache types at once:

n98-magerun2.phar cache:clean [code] [code] ...

If you would like to remove all cache entries use cache:flush

Run cache:list command to see all codes.

Remove all cache entries

n98-magerun2.phar cache:flush [code]

Keep in mind that cache:flush cleares the cache backend, so other cache types in the same backend will be cleared as well.

List Magento caches

n98-magerun2.phar cache:list [--format[="..."]]

Disable Magento cache

n98-magerun2.phar cache:disable [code]

If no code is specified, all cache types will be disabled. Run cache:list command to see all codes.

Enable Magento cache

n98-magerun2.phar cache:enable [code]

If no code is specified, all cache types will be enabled. Run cache:list command to see all codes.

List admin users

n98-magerun2.phar admin:user:list [--format[="..."]]

Change admin user password

n98-magerun2.phar admin:user:change-password [username] [password]

Delete admin user

n98-magerun2.phar admin:user:delete [email|username] [-f]

ID can be e-mail or username. The command will attempt to find the user by username first and if it cannot be found it will attempt to find the user by e-mail. If ID is omitted you will be prompted for it. If the force parameter -f is omitted you will be prompted for confirmation.

Create Admin Token for Webapi

n98-magerun2.phar admin:token:create <username>

Run a raw DB query

n98-magerun2.phar db:query <sql-query>

Example:

n98-magerun2.phar db:query "select * from store"

Open MySQL Console

n98-magerun2.phar db:console [options]

Options:

Dump database

Dumps configured Magento database with mysqldump.

• Requires MySQL CLI tools

Arguments

• filename - Dump filename

Options

n98-magerun2.phar db:dump

Only the mysqldump command:

n98-magerun2.phar db:dump --only-command [filename]

Or directly to stdout:

n98-magerun2.phar db:dump --stdout

Use compression (gzip cli tool has to be installed):

n98-magerun2.phar db:dump --compression="gzip"

Stripped Database Dump

Dumps your database and excludes some tables. This is useful for development or staging environments where you may want to provision a restricted database.

Separate each table to strip by a space. You can use wildcards like * and ? in the table names to strip multiple tables. In addition you can specify pre-defined table groups, that start with an @
Example: dataflow_batch_export unimportant_module_* @log

n98-magerun2.phar db:dump --strip="@stripped"

Available Table Groups:

Import database

• Requires MySQL CLI tools

Arguments

• filename - Dump filename

Options

n98-magerun2.phar db:import

Fix empty authorization tables

If you run db:dump with stripped option and @admin group, the authorization_rule and authorization_role tables are empty. This blocks the creation of admin users.

You can re-create the default entries by running the command:

n98-magerun2.phar db:add-default-authorization-entries

If you are using the db:import command to import the stripped SQL dump, then this command will be implicitly called.

Clear static view files

n98-magerun2.phar dev:asset:clear [--theme="..."]

Options

To clear assets for all themes:

n98-magerun2.phar dev:asset:clear

To clear assets for specific theme(s) only:

n98-magerun2.phar dev:asset:clear --theme=Magento/luma

List Themes

n98-magerun2.phar dev:theme:list

Create Module Skeleton

Creates an empty module and registers it in current Magento shop.

n98-magerun2.phar dev:module:create [-m|--minimal] [--add-blocks] [--add-helpers] [--add-models] [--add-setup] [--add-all] [-e|--enable] [--modman] [--add-readme] [--add-composer] [--add-strict-types] [--author-name [AUTHOR-NAME]] [--author-email [AUTHOR-EMAIL]] [--description [DESCRIPTION]] [-h|--help] [-q|--quiet] [-v|vv|vvv|--verbose] [-V|--version] [--ansi] [--no-ansi] [-n|--no-interaction] [--root-dir [ROOT-DIR]] [--skip-config] [--skip-root-check] [--skip-core-commands [SKIP-CORE-COMMANDS]] [--skip-magento-compatibility-check] [--] <command> <vendorNamespace> <moduleName>

Detect Composer Dependencies in Module

The source code of one or more modules can be scanned for dependencies.

n98-magerun2.phar dev:module:detect-composer-dependencies [--only-missing] <directory>

The --only-missing option will filter the output so that only the missing dependencies are listed.

Enable/disable inline translation feature for Magento Admin:

n98-magerun2.phar dev:translate:admin [--on] [--off]

Enable/disable inline translation feature for shop frontend:

n98-magerun2.phar dev:translate:shop [--on] [--off] <store>

Set a translation (saved in translation table)

n98-magerun2.phar dev:translate:set <string> <translate> [<store>]

Export inline translations

n98-magerun2.phar dev:translate:export [--store=<storecode>] <locale> <filename>

List modules

n98-magerun2.phar dev:module:list [--vendor=VENDOR]

List Observers

n98-magerun2.phar dev:module:observer:list [--sort] <event> [<area>

List Routes

n98-magerun2.phar route:list [-a|--area] [-m|--module] [-f|--format]

EAV Attributes

View the data for a particular attribute:

n98-magerun2.phar eav:attribute:view [--format[="..."]] entityType attributeCode

Generate Gift Card Pool

Generates a new gift card pool.

n98-magerun2.phar giftcard:pool:generate

Create a Gift Card

n98-magerun2.phar giftcard:create [--website[="..."]] [--expires[="..."]] [amount]

You may specify a website ID or use the default. You may also optionally add an expiration date to the gift card using the --expires option. Dates should be in YYYY-MM-DD format.

View Gift Card Information

n98-magerun2.phar giftcard:info [--format[="..."]] [code]

Remove a Gift Card

n98-magerun2.phar giftcard:remove [code]

Compare Setup Versions

Compares module version with saved setup version in setup_module table and displays version mismatchs if found.

n98-magerun2.phar sys:setup:compare-versions [--ignore-data] [--log-junit="..."] [--format[="..."]]

• If a filename with --log-junit option is set the tool generates an XML file and no output to stdout.

Change Setup Version

Changes the version of a module. This command is useful if you want to re-run an upgrade script again possibly for debugging. Alternatively you would have to alter the row in the database manually.

n98-magerun2.phar sys:setup:change-version module version

Downgrade Setup Versions

Downgrade the versions in the database to the module version from its xml file if necessary. Useful while developing and switching branches between module version changes.

n98-magerun2.phar sys:setup:downgrade-versions

Dump Media folder

Creates a ZIP archive with media folder content.

n98-magerun2.phar media:dump [--strip] [filename]

Integrations (Webapi Access Tokens)

There are four commands to create, show, list, delete integrations (access tokens). This commands are very useful for developers.

List all existing integrations

n98-magerun2.phar integration:list

Create a new integration

n98-magerun2.phar integration:create [options] [--] <name> <email> <endpoint>

Options

If no ACL resource is defined the new integration token will be created with FULL ACCESS.

If you do not want that, please provide a list of ACL resources by using the --resource option.

Example:

n98-magerun2.phar integration:create "My new integration 10" [email protected] https://example.com -r Magento_Catalog::catalog_inventory -r Magento_Backend::system_other_settings

To see all available ACL resources, please run the command config:data:acl.

Show infos about existing integration

n98-magerun2.phar integration:show --format[=FORMAT] <name_or_id> [key]

Example (print only Access Key):

n98-magerun2.phar integration:show 1 "Access Key"

Delete integration

n98-magerun2.phar integration:delete <name_or_id>

Github

(experimental) Commands

Pull Requests

Gets infos about Github Pull Requests. If no Github Repository is defined by ---repository (-r) option the default Magento 2 Github Repository magento/magento2 is used. For the Mage-OS repository we provide a shortcut option --mage-os.

If the command is executed without any options it will show infos about the PR.

# Magento 2 Open Source
n98-magerun2.phar github:pr:patch <pr-number>

# Mage-OS
n98-magerun2.phar github:pr:patch --mage-os <pr-number>

Create a patch file from PR:

n98-magerun2.phar github:pr:patch --patch <pr-number>

Files of the magento2-base and magento2-ee-base and b2b base packages are currently not handled by the command.

List only the raw diff:

n98-magerun2.phar github:pr:patch --diff <pr-number>

Interactive Development Console

Opens PHP interactive shell with initialized Magento Admin-Store.

n98-magerun2.phar dev:console [--area=AREA] <arg>

Optional an area code can be defined. If provided, the configuration (di.xml, translations) of the area are loaded.

Possible area codes are:

• adminhtml
• crontab
• frontend
• graphql
• webapi_xml
• webapi_rest

Variable $di is made available with a Magento\Framework\ObjectManagerInterface instance to allow creation of object instances.

Variable $dh provides convenient debugging functions. Type $dh-> and press Tab for a list.

Example:

n98-magerun2 dev:console --area=adminhtml
    // show name of category 123 in default store
    $dh->debugCategoryById(123)['name']; 
    // show name of product id 123
    $dh->debugProductById(123)['name']; 

The interactive console works as REPL. It's possible to enter any PHP code. The code will be executed immediately. The interactive console also comes with a lot of embedded scommands.

It's possible to add initial commands to the interactive console. Commands should be delimited by a semicolon. You can mix PHP-Code with embedded interactive console commands.

Example:

n98-magerun2.phar dev:console "$a = 1; call cache:flush; ls;"

The interactive console comes with a extendable code generator tool to create i.e. modules, cli commands, controllers, blocks, helpers etc.

The console can be in a module context which allows you to generate code for a selected module.

The basic idea of the stateful console was developed by Jacques Bodin-Hullin in this great tool Installer.

n98-magerun Script

Run multiple commands from a script file.

n98-magerun2.phar script [-d|--define[="..."]] [--stop-on-error] [filename]

Example:

# Set multiple config
config:store:set "web/cookie/cookie_domain" example.com

# Set with multiline values with `\n`
config:store:set "general/store_information/address" "First line\nSecond line\nThird line"

# This is a comment
cache:flush

Optionally you can work with unix pipes.

echo "cache:flush" | n98-magerun2.phar script

n98-magerun2.phar script < filename

It is even possible to create executable scripts:

Create file test.magerun and make it executable chmod +x test.magerun:

#!/usr/bin/env n98-magerun2.phar script

config:store:set "web/cookie/cookie_domain" example.com
cache:flush

# Run a shell script with "!" as first char
! ls -l

# Register your own variable (only key = value currently supported)
${my.var}=bar

# Let magerun ask for variable value - add a question mark
${my.var}=?

! echo ${my.var}

# Use resolved variables from n98-magerun in shell commands
! ls -l ${magento.root}/code/local

Pre-defined variables:

Variables can be passed to a script with "--define (-d)" option.

Example:

n98-magerun2.phar script -d foo=bar filename

# This will register the variable ${foo} with value bar.

It's possible to define multiple values by passing more than one option.

Environment variables can be used in a script by using the env. prefix.

Example:

!echo "My current working directory is: ${env.PWD}"
!echo "Path: ${env.PATH}"

Toggle CMS Block status

Toggles the status for a CMS block based on the given Block identifier.

n98-magerun2.phar cms:block:toggle [blockId]

Change Admin user status

Changes the admin user based on the options, the command will toggle the status if no options are supplied.

n98-magerun2.phar admin:user:change-status [user] [--activate] [--deactivate]

Note: It is possible for a user to exist with a username that matches the email of a different user. In this case the first matched user will be changed.

Add Sales Sequences for a given store

Create sales sequences in the database if they are missing, this will recreate profiles to.

n98-magerun2.phar sales:sequence:add [store] 

If store is omitted, it'll run for all stores.

Note: It is possible a sequence already exists, in this case nothing will happen, only missing tables are created.

Remove Sales Sequences for a given store

Remove sales sequences from the database, warning, you cannot undo this, make sure you have database backups.

n98-magerun2.phar sales:sequence:remove [store] 

If store is omitted, it'll run for all stores. When the option no-interaction is given, it will run immediately without any interaction. Otherwise it will remind you and ask if you know what you're doing and ask for each store you are running it on.

Note: .

Script Repository

You can organize your scripts in a repository. Simply place a script in folder /usr/local/share/n98-magerun2/scripts or in your home dir in folder /.n98-magerun2/scripts.

Scripts must have the file extension .magerun.

After that you can list all scripts with the script:repo:list command. The first line of the script can contain a comment (line prefixed with #) which will be displayed as description.

$ n98-magerun2.phar script:repo:list [--format[="..."]]

If you want to execute a script from the repository this can be done by script:repo:run command.

$ n98-magerun2.phar script:repo:run [-d|--define[="..."]] [--stop-on-error] [script]

Script argument is optional. If you don't specify any you can select one from a list.

Composer Redeploy Base Packages

If files are missing after a Magento updates it could be that new files were added to the files map in the base packages of Magento. The composer:redeploy-base-packages command can fix this issue.

$ n98-magerun2.phar composer:redeploy-base-packages

Development

https://github.com/netz98/n98-magerun2/wiki