netz98 magerun CLI tools for Magento 2

The n98 magerun cli tools provides some handy tools to work with Magento from command line.

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.3.x Open Source/Commerce

We support the following PHP Versions:

• PHP 7.3
• PHP 7.2

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 3.2.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 with Composer

The installation via Composer is not recommended. 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

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:

Parameter	Description
--root-dir	Force Magento root dir. No auto detection.
--skip-config	Do not load any custom config.
--skip-root-check	Do not check if n98-magerun2 runs as root.
--skip-core-commands	Do not include Magento commands.
--skip-magento-compatibility-check	Do not check Magento version compatibility.

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

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>

---

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 info like the edition and version or the configured cache backends.

$ n98-magerun2.phar sys:info

---

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[="..."]]

---

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>]

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' '*'

Show env.php settings

$ n98-magerun2.phar config:env:show 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:

Option	Description
--scope	The config value's scope (default: default). Can be default, websites, stores)
--scope-id	The config value's scope ID (default: 0)
--encrypt	Encrypt the config value using crypt key

Get Store Config

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

Arguments:

• path - The config path

Options:

Option	Description
--scope	The config value's scope (default, websites, stores)
--scope-id	The config value's scope ID
--decrypt	Decrypt the config value using crypt key defined in env.php
--update-script	Output as update script lines
--magerun-script	Output for usage with config:store:set
--format	Output as json, xml or csv

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:

Option	Description
--scope	The config value's scope (default, websites, stores)
--scope-id	The config value's scope ID
--all	Delete all entries by path

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:

Option	Description
--scope -s	Config scope (global, adminhtml, frontend, webapi_rest, webapi_soap, ...) (default: global)

---

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:

Option	Description
--use-mycli-instead-of-mysql	Use mycli as the MySQL client instead of mysql
--no-auto-rehash	Same as -A option to MySQL client to turn off auto-complete (avoids long initial connection time).
--connection=CONNECTION	Select DB connection type for Magento configurations with several databases (default: default)

Dump database

Dumps configured Magento database with mysqldump.

• Requires MySQL CLI tools

Arguments

• filename - Dump filename

Options

Option	Description
--add-time	Adds time to filename (only if filename was not provided)
--compression -c	Compress the dump file using one of the supported algorithms
--only-command	Print only mysqldump command. Does not execute.
--print-only-filename	Execute and prints not output except the dump filename
--dry-run	Do everything but the actual dump. Useful to test.
--no-single-transaction	Do not use single-transaction (not recommended, this is blocking)
--human-readable	Use a single insert with column names per row.
--git-friendly	Use one insert statement, but with line breaks instead of separate insert statements.
--add-routines	Include stored routines in dump (procedures & functions).
--stdout	Dump to stdout
--strip	Tables to strip (dump only structure of those tables)
--exclude	Tables to exclude entirely from the dump (including structure)
--force -f	Do not prompt if all options are defined
--keep-column-statistics	Retains column statistics table in mysqldump

$ 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:

Table Group	Description
@2fa	2FA tables. These tables are used for storing 2FA information for admin users.
@admin	Admin users, roles, sessions, etc.
@aggregated	Aggregated tables used for generating reports, etc.
@dotmailer	Dotmailer data(email_abandoned_cart email_automation email_campaign email_contact).
@customers	Customer data (and company data from the B2B extension).
@development	Removes logs, sessions, trade data and admin users so developers do not have to work with real customer data or admin user accounts.
@dotmailer	Dotmailer module tables
@ee_changelog	Changelog tables of new indexer since EE 1.13
@idx	Tables with _idx suffix and index event tables
@klarna	Klarna tables containing information about klarna payments and their quotes/orders.
@log	Log tables
@newrelic_reporting	New Relic reporting tables. These tables provide production metric data for New Relic.
@oauth	OAuth sessions, tokens, etc.
@quotes	Cart (quote) data and B2B quotes.
@replica	Replica tables, these are generated from Magento Staging functionality.
@sales	Sales data (orders, invoices, creditmemos etc).
@search	Search related tables (catalogsearch_).
@sessions	Database session tables.
@stripped	Standard definition for a stripped dump (logs and sessions).
@trade	Current trade data (customers, orders and quotes). You usually do not want those in developer systems.
@temp	Indexer __temp tables

---

Clear static view files

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

Options

Option	Description
--theme	The specific theme(s) to clear

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

---

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

Option	Description
--consumer-key=CONSUMER-KEY	Consumer Key (length 32 chars)
--consumer-secret=CONSUMER-SECRET	Consumer Secret (length 32 chars)
--access-token=ACCESS-TOKEN	Access-Token (length 32 chars)
--access-token-secret=ACCESS-TOKEN-SECRET	Access-Token Secret (length 32 chars)
--resource=RESOURCE -r	Defines a granted ACL resource (multiple values allowed)

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 <name_or_id>

Delete integration

$ n98-magerun2.phar integration:delete <name_or_id>

---

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.

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 commands.

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 Shell

If you need autocompletion for all n98-magerun commands you can start with shell command.

$ n98-magerun2.phar shell

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:

Variable	Description
${magento.root}	Magento Root-Folder
${magento.version}	Magento Version i.e. 2.0.0.0
${magento.edition}	Magento Edition -> Community or Enterprise
${magerun.version}	Magerun version i.e. 2.1.0
${php.version}	PHP Version
${script.file}	Current script file path
${script.dir}	Current script file dir

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.