Welcome to n98-magerun documentation!¶

Contents:

Overview¶

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

Compatibility¶

The tools will automatically be tested for multiple PHP versions (5.3, 5.4, 5.5). It’s currently 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).

The tool partially works with Magento 2 development branch.

Installation/Update¶

Installation¶

There are two ways to install the tools:

Download phar file¶

wget https://raw.github.com/netz98/n98-magerun/master/n98-magerun.phar

or if you have problems with SSL certificate:

curl -o n98-magerun.phar https://raw.github.com/netz98/n98-magerun/master/n98-magerun.phar

You can make the .phar file executable.

chmod +x ./n98-magerun.phar

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

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

Debian / suhosin:

On some debian systems with compiled in suhosin the phar extension must be added to a whitelist.

Add this to your php.ini file:

suhosin.executor.include.whitelist="phar"

You don’t like the filename?

Just rename it to whatever you want.

Install with Composer¶

https://github.com/netz98/n98-magerun/wiki/Install-from-source-with-Composer

Update¶

Since version 1.1.0 we deliver a self-update script within the phar file:

$ n98-magerun.phar self-update

If file was installed system wide do not forget “sudo”.

See it in action: http://youtu.be/wMHpfKD9vjM

Standalone Commands¶

help¶

Displays help for a command

The &lt;info&gt;help&lt;/info&gt; command displays help for a given command:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun help list&lt;/info&gt;

You can also output the help in other formats by using the &lt;comment&gt;–format&lt;/comment&gt; option:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun help –format=xml list&lt;/info&gt;

To display the list of available commands, please use the &lt;info&gt;list&lt;/info&gt; command.

Usage:

$ n98-magerun.phar help [--xml] [--format=&amp;quot;...&amp;quot;] [--raw] [command_name]

Arguments¶

command_name

Is required:

No

Is array:

No

Description:

The command name

Default:

help

Options¶

–xml

Description:

To output help as XML

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–format

Description:

To output help in other formats

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–raw

Description:

To output raw command help

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

install¶

Install magento

Usage:

$ n98-magerun.phar install [--magentoVersion[=&amp;quot;...&amp;quot;]] [--magentoVersionByName[=&amp;quot;...&amp;quot;]] [--installationFolder[=&amp;quot;...&amp;quot;]] [--dbHost[=&amp;quot;...&amp;quot;]] [--dbUser[=&amp;quot;...&amp;quot;]] [--dbPass[=&amp;quot;...&amp;quot;]] [--dbName[=&amp;quot;...&amp;quot;]] [--installSampleData[=&amp;quot;...&amp;quot;]] [--useDefaultConfigParams[=&amp;quot;...&amp;quot;]] [--baseUrl[=&amp;quot;...&amp;quot;]] [--replaceHtaccessFile[=&amp;quot;...&amp;quot;]]

Options¶

–magentoVersion

Description:

Magento version

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–magentoVersionByName

Description:

Magento version name instead of order number

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–installationFolder

Description:

Installation folder

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbHost

Description:

Database host

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbUser

Description:

Database user

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbPass

Description:

Database password

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbName

Description:

Database name

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–installSampleData

Description:

Install sample data

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–useDefaultConfigParams

Description:

Use default installation parameters defined in the yaml file

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–baseUrl

Description:

Installation base url

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–replaceHtaccessFile

Description:

Generate htaccess file (for non vhost environment)

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

list¶

Lists commands

The &lt;info&gt;list&lt;/info&gt; command lists all commands:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list&lt;/info&gt;

You can also display the commands for a specific namespace:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list test&lt;/info&gt;

You can also output the information in other formats by using the &lt;comment&gt;–format&lt;/comment&gt; option:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list –format=xml&lt;/info&gt;

It&#039;s also possible to get raw list of commands (useful for embedding command runner):

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list –raw&lt;/info&gt;

Usage:

$ n98-magerun.phar list [--xml] [--raw] [--format=&amp;quot;...&amp;quot;] [namespace]

Arguments¶

namespace

Is required:

No

Is array:

No

Description:

The namespace name

Default:

n/a

Options¶

–xml

Description:

To output list as XML

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–raw

Description:

To output raw command list

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–format

Description:

To output list in other formats

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

open-browser¶

Open current project in browser &lt;comment&gt;(experimental)&lt;/comment&gt;

Usage:

$ n98-magerun.phar open-browser [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

script¶

Runs multiple n98-magerun commands

Usage:

$ n98-magerun.phar script [-d|--define[=&amp;quot;...&amp;quot;]] [filename]

Arguments¶

filename

Is required:

No

Is array:

No

Description:

Script file

Default:

n/a

Options¶

–define

Description:

Defines a variable

Shortcut:

-d

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

shell¶

Runs n98-magerun as shell

Usage:

$ n98-magerun.phar shell

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

uninstall¶

Uninstall magento (drops database and empties current folder

Usage:

$ n98-magerun.phar uninstall [-f|--force]

Options¶

–force

Description:

Force

Shortcut:

-f

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Admin Commands¶

admin:notifications¶

Toggles admin notifications

Usage:

$ n98-magerun.phar admin:notifications [--on] [--off]

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

admin:user:change-password¶

Changes the password of a adminhtml user.

Usage:

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

Arguments¶

username

Is required:

No

Is array:

No

Description:

Username

Default:

n/a

password

Is required:

No

Is array:

No

Description:

Password

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

admin:user:create¶

Create admin user.

Usage:

$ n98-magerun.phar admin:user:create [username] [email] [password] [firstname] [lastname] [role]

Arguments¶

username

Is required:

No

Is array:

No

Description:

Username

Default:

n/a

email

Is required:

No

Is array:

No

Description:

Email, empty string = generate

Default:

n/a

password

Is required:

No

Is array:

No

Description:

Password

Default:

n/a

firstname

Is required:

No

Is array:

No

Description:

Firstname

Default:

n/a

lastname

Is required:

No

Is array:

No

Description:

Lastname

Default:

n/a

role

Is required:

No

Is array:

No

Description:

Role

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

admin:user:list¶

List admin users.

Usage:

$ n98-magerun.phar admin:user:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Cache Commands¶

cache:clean¶

Clean magento cache

Cleans expired cache entries. If you like to remove all entries use cache:flush Or only one cache type like i.e. full_page cache:

$ n98-magerun.phar cache:clean full_page

Usage:

$ n98-magerun.phar cache:clean [type]

Arguments¶

type

Is required:

No

Is array:

No

Description:

Cache type code like &quot;config&quot;

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

cache:disable¶

Disables magento caches

Usage:

$ n98-magerun.phar cache:disable

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

cache:enable¶

Enables magento caches

Usage:

$ n98-magerun.phar cache:enable

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

cache:flush¶

Flush magento cache storage

Usage:

$ n98-magerun.phar cache:flush

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

cache:list¶

Lists all magento caches

Usage:

$ n98-magerun.phar cache:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Composer Commands¶

composer:diagnose¶

Diagnoses the system to identify common errors.

The &lt;info&gt;diagnose&lt;/info&gt; command checks common errors to help debugging problems.

Usage:

$ n98-magerun.phar composer:diagnose

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

composer:init¶

Creates a basic composer.json file in current directory.

The &lt;info&gt;init&lt;/info&gt; command creates a basic composer.json file in the current directory.

&lt;info&gt;php composer.phar init&lt;/info&gt;

Usage:

$ n98-magerun.phar composer:init [--name=&amp;quot;...&amp;quot;] [--description=&amp;quot;...&amp;quot;] [--author=&amp;quot;...&amp;quot;] [--homepage=&amp;quot;...&amp;quot;] [--require=&amp;quot;...&amp;quot;] [--require-dev=&amp;quot;...&amp;quot;] [-s|--stability=&amp;quot;...&amp;quot;] [-l|--license=&amp;quot;...&amp;quot;]

Options¶

–name

Description:

Name of the package

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–description

Description:

Description of package

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–author

Description:

Author name of package

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–homepage

Description:

Homepage of package

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–require

Description:

Package to require with a version constraint, e.g. foo/bar:1.0.0 or foo/bar=1.0.0 or &quot;foo/bar 1.0.0&quot;

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–require-dev

Description:

Package to require for development with a version constraint, e.g. foo/bar:1.0.0 or foo/bar=1.0.0 or &quot;foo/bar 1.0.0&quot;

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–stability

Description:

Minimum stability (empty or one of: stable, RC, beta, alpha, dev)

Shortcut:

-s

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–license

Description:

License of package

Shortcut:

-l

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

composer:install¶

Installs the project dependencies from the composer.lock file if present, or falls back on the composer.json.

The &lt;info&gt;install&lt;/info&gt; command reads the composer.lock file from the current directory, processes it, and downloads and installs all the libraries and dependencies outlined in that file. If the file does not exist it will look for composer.json and do the same.

&lt;info&gt;php composer.phar install&lt;/info&gt;

Usage:

$ n98-magerun.phar composer:install [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-dev] [--no-plugins] [--no-custom-installers] [--no-scripts] [--no-progress] [-v|vv|vvv|--verbose] [-o|--optimize-autoloader]

Options¶

–prefer-source

Description:

Forces installation from package sources when possible, including VCS information.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–prefer-dist

Description:

Forces installation from package dist even for dev versions.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dry-run

Description:

Outputs the operations but will not execute anything (implicitly enables –verbose).

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dev

Description:

Enables installation of require-dev packages (enabled by default, only present for BC).

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-dev

Description:

Disables installation of require-dev packages.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-plugins

Description:

Disables all plugins.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-custom-installers

Description:

DEPRECATED: Use no-plugins instead.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-scripts

Description:

Skips the execution of all scripts defined in composer.json file.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-progress

Description:

Do not output download progress.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–optimize-autoloader

Description:

Optimize autoloader during autoloader dump

Shortcut:

-o

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

composer:require¶

Adds required packages to your composer.json and installs them

The require command adds required packages to your composer.json and installs them

If you do not want to install the new dependencies immediately you can call it with –no-update

Usage:

$ n98-magerun.phar composer:require [--dev] [--prefer-source] [--prefer-dist] [--no-progress] [--no-update] [packages1] ... [packagesN]

Arguments¶

packages

Is required:

No

Is array:

Yes

Description:

Required package with a version constraint, e.g. foo/bar:1.0.0 or foo/bar=1.0.0 or &quot;foo/bar 1.0.0&quot;

Default:

n/a

Options¶

–dev

Description:

Add requirement to require-dev.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–prefer-source

Description:

Forces installation from package sources when possible, including VCS information.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–prefer-dist

Description:

Forces installation from package dist even for dev versions.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-progress

Description:

Do not output download progress.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-update

Description:

Disables the automatic update of the dependencies.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

composer:search¶

Search for packages

The search command searches for packages by its name &lt;info&gt;php composer.phar search symfony composer&lt;/info&gt;

Usage:

$ n98-magerun.phar composer:search [-N|--only-name] tokens1 ... [tokensN]

Arguments¶

tokens

Is required:

Yes

Is array:

Yes

Description:

tokens to search for

Default:

n/a

Options¶

–only-name

Description:

Search only in name

Shortcut:

-N

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

composer:update¶

Updates your dependencies to the latest version according to composer.json, and updates the composer.lock file.

The &lt;info&gt;update&lt;/info&gt; command reads the composer.json file from the current directory, processes it, and updates, removes or installs all the dependencies.

&lt;info&gt;php composer.phar update&lt;/info&gt;

To limit the update operation to a few packages, you can list the package(s) you want to update as such:

&lt;info&gt;php composer.phar update vendor/package1 foo/mypackage [...]&lt;/info&gt;

Usage:

$ n98-magerun.phar composer:update [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-dev] [--lock] [--no-plugins] [--no-custom-installers] [--no-scripts] [--no-progress] [-v|vv|vvv|--verbose] [-o|--optimize-autoloader] [packages1] ... [packagesN]

Arguments¶

packages

Is required:

No

Is array:

Yes

Description:

Packages that should be updated, if not provided all packages are.

Default:

n/a

Options¶

–prefer-source

Description:

Forces installation from package sources when possible, including VCS information.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–prefer-dist

Description:

Forces installation from package dist even for dev versions.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dry-run

Description:

Outputs the operations but will not execute anything (implicitly enables –verbose).

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dev

Description:

Enables installation of require-dev packages (enabled by default, only present for BC).

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-dev

Description:

Disables installation of require-dev packages.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–lock

Description:

Only updates the lock file hash to suppress warning about the lock file being out of date.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-plugins

Description:

Disables all plugins.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-custom-installers

Description:

DEPRECATED: Use no-plugins instead.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-scripts

Description:

Skips the execution of all scripts defined in composer.json file.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-progress

Description:

Do not output download progress.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–optimize-autoloader

Description:

Optimize autoloader during autoloader dump

Shortcut:

-o

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

composer:validate¶

Validates a composer.json

The validate command validates a given composer.json

Usage:

$ n98-magerun.phar composer:validate [file]

Arguments¶

file

Is required:

No

Is array:

No

Description:

path to composer.json file

Default:

./composer.json

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Config Commands¶

config:delete¶

Deletes a store config item

To delete all entries if a path you can set the option –all.

Usage:

$ n98-magerun.phar config:delete [--scope[=&amp;quot;...&amp;quot;]] [--scope-id[=&amp;quot;...&amp;quot;]] [--all] path

Arguments¶

path

Is required:

Yes

Is array:

No

Description:

The config path

Default:

n/a

Options¶

–scope

Description:

The config value&#039;s scope (default, websites, stores)

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

default

–scope-id

Description:

The config value&#039;s scope ID

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–all

Description:

Delete all entries by path

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

config:dump¶

Dump merged xml config

Dumps merged XML configuration to stdout. Useful to see all the XML. You can filter the XML with first argument.

Examples:

Config of catalog module

$ n98-magerun.phar config:dump global/catalog

See module order in XML

$ n98-magerun.phar config:dump modules

Write output to file

$ n98-magerun.phar config:dump &gt; extern_file.xml

Usage:

$ n98-magerun.phar config:dump [xpath]

Arguments¶

xpath

Is required:

No

Is array:

No

Description:

XPath to filter XML output

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

config:get¶

Get a core config item

If &lt;info&gt;path&lt;/info&gt; is not set, all available config items will be listed. The &lt;info&gt;path&lt;/info&gt; may contain wildcards (*). If &lt;info&gt;path&lt;/info&gt; ends with a trailing slash, all child items will be listed. E.g.

config:get web/

is the same as: config:get web/*

Usage:

$ n98-magerun.phar config:get [--scope=&amp;quot;...&amp;quot;] [--scope-id=&amp;quot;...&amp;quot;] [--decrypt] [--update-script] [--magerun-script] [path]

Arguments¶

path

Is required:

No

Is array:

No

Description:

The config path

Default:

n/a

Options¶

–scope

Description:

The config value&#039;s scope

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–scope-id

Description:

The config value&#039;s scope ID

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–decrypt

Description:

Decrypt the config value using local.xml&#039;s crypt key

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–update-script

Description:

Output as update script lines

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–magerun-script

Description:

Output for usage with config:set

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

config:search¶

Search system configuration descriptions.

Searches the merged system.xml configuration tree &lt;labels/&gt; and &lt;comments/&gt; for the indicated text.

Usage:

$ n98-magerun.phar config:search text

Arguments¶

text

Is required:

Yes

Is array:

No

Description:

The text to search for

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

config:set¶

Set a core config item

Set a store config value by path. To set a value of a specify store view you must set the &quot;scope&quot; and &quot;scope-id&quot; option.

Usage:

$ n98-magerun.phar config:set [--scope[=&amp;quot;...&amp;quot;]] [--scope-id[=&amp;quot;...&amp;quot;]] [--encrypt] path value

Arguments¶

path

Is required:

Yes

Is array:

No

Description:

The config path

Default:

n/a

value

Is required:

Yes

Is array:

No

Description:

The config value

Default:

n/a

Options¶

–scope

Description:

The config value&#039;s scope (default, websites, stores)

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

default

–scope-id

Description:

The config value&#039;s scope ID

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–encrypt

Description:

The config value should be encrypted using local.xml&#039;s crypt key

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Customer Commands¶

customer:change-password¶

Changes the password of a customer.

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

Usage:

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

Arguments¶

email

Is required:

No

Is array:

No

Description:

Email

Default:

n/a

password

Is required:

No

Is array:

No

Description:

Password

Default:

n/a

website

Is required:

No

Is array:

No

Description:

Website of the customer

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

customer:create¶

Creates a new customer/user for shop frontend.

Usage:

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

Arguments¶

email

Is required:

No

Is array:

No

Description:

Email

Default:

n/a

password

Is required:

No

Is array:

No

Description:

Password

Default:

n/a

firstname

Is required:

No

Is array:

No

Description:

Firstname

Default:

n/a

lastname

Is required:

No

Is array:

No

Description:

Lastname

Default:

n/a

website

Is required:

No

Is array:

No

Description:

Website

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

customer:create:dummy¶

Generate dummy customers. You can specify a count and a locale.

Supported Locales:

cs_CZ
ru_RU
bg_BG
en_US
it_IT
sr_RS
sr_Cyrl_RS
sr_Latn_RS
pl_PL
en_GB
de_DE
sk_SK
fr_FR
es_AR
de_AT

Usage:

$ n98-magerun.phar customer:create:dummy count locale [website]

Arguments¶

count

Is required:

Yes

Is array:

No

Description:

Count

Default:

n/a

locale

Is required:

Yes

Is array:

No

Description:

Locale

Default:

n/a

website

Is required:

No

Is array:

No

Description:

Website

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

customer:info¶

Loads basic customer info by email address.

Usage:

$ n98-magerun.phar customer:info [email] [website]

Arguments¶

email

Is required:

No

Is array:

No

Description:

Email

Default:

n/a

website

Is required:

No

Is array:

No

Description:

Website of the customer

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

customer:list¶

Lists 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).

Usage:

$ n98-magerun.phar customer:list [search]

Arguments¶

search

Is required:

No

Is array:

No

Description:

Search query

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Db Commands¶

db:console¶

Opens mysql client by database config from local.xml

Usage:

$ n98-magerun.phar db:console

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

db:create¶

Create currently configured database

The command tries to create the configured database according to your settings in app/etc/local.xml. The configured user must have &quot;CREATE DATABASE&quot; privileges on MySQL Server.

Usage:

$ n98-magerun.phar db:create

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

db:drop¶

Drop current database

The command prompts before dropping the database. If –force option is specified it directly drops the database. The configured user in app/etc/local.xml must have &quot;DROP&quot; privileges.

Usage:

$ n98-magerun.phar db:drop [-f|--force]

Options¶

–force

Description:

Force

Shortcut:

-f

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

db:dump¶

Dumps database with mysqldump cli client according to informations from local.xml

Dumps configured magento database with mysqldump. You must have installed the MySQL client tools.

On debian systems run apt-get install mysql-client to do that.

The command reads app/etc/local.xml to find the correct settings. If you like to skip data of some tables you can use the –strip option. The strip option creates only the structure of the defined tables and forces mysqldump to skip the data.

Dumps your database and excludes some tables. This is useful i.e. for development.

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: &quot;dataflow_batch_export unimportant_module_* @log

$ n98-magerun.phar db:dump –strip=&quot;@stripped&quot;

Available Table Groups:

@log Log tables
@dataflowtemp Temporary tables of the dataflow import/export tool
@stripped Standard definition for a stripped dump (logs and dataflow)
@sales Sales data (orders, invoices, creditmemos etc)
@customers Customer data
@trade Current trade data (customers and orders). You usally do not want those in developer systems.
@development Removes logs and trade data so developers do not have to work with real customer data

Extended: https://github.com/netz98/n98-magerun/wiki/Stripped-Database-Dumps

See it in action: http://youtu.be/ttjZHY6vThs

If you like to prepend a timestamp to the dump name the –add-time option can be used.
The command comes with a compression function. Add i.e. –compress=gz to dump directly in

gzip compressed file.

&lt;comment&gt;Compression option&lt;/comment&gt;: Supported compression: gzip The gzip cli tool has to be installed. Additionally, for data-to-csv option tar cli tool has to be installed too.
&lt;comment&gt;Strip option&lt;/comment&gt;: 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: &quot;dataflow_batch_export unimportant_module_* @log
&lt;comment&gt;Available Table Groups&lt;/comment&gt;: &lt;info&gt;@log&lt;/info&gt; Log tables &lt;info&gt;@dataflowtemp&lt;/info&gt; Temporary tables of the dataflow import/export tool &lt;info&gt;@stripped&lt;/info&gt; Standard definition for a stripped dump (logs and dataflow) &lt;info&gt;@sales&lt;/info&gt; Sales data (orders, invoices, creditmemos etc) &lt;info&gt;@customers&lt;/info&gt; Customer data - Should not be used without @sales &lt;info&gt;@trade&lt;/info&gt; Current trade data (customers and orders). You usally do not want those in developer systems. &lt;info&gt;@development&lt;/info&gt; Removes logs and trade data so developers do not have to work with real customer data &lt;info&gt;@ee_changelog&lt;/info&gt; Changelog tables of new indexer since EE 1.13 &lt;info&gt;@idx&lt;/info&gt; Tables with _idx suffix

Usage:

$ n98-magerun.phar db:dump [-t|--add-time[=&amp;quot;...&amp;quot;]] [-c|--compression=&amp;quot;...&amp;quot;] [--only-command] [--print-only-filename] [--no-single-transaction] [--human-readable] [--stdout] [-s|--strip[=&amp;quot;...&amp;quot;]] [-f|--force] [filename]

Arguments¶

filename

Is required:

No

Is array:

No

Description:

Dump filename

Default:

n/a

Options¶

–add-time

Description:

Adds time to filename (only if filename was not provided)

Shortcut:

-t

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–compression

Description:

Compress the dump file using one of the supported algorithms

Shortcut:

-c

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–only-command

Description:

Print only mysqldump command. Do not execute

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–print-only-filename

Description:

Execute and prints no output except the dump filename

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-single-transaction

Description:

Do not use single-transaction (not recommended, this is blocking)

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–human-readable

Description:

Use a single insert with column names per row. Useful to track database differences, but significantly slows down a later import

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–stdout

Description:

Dump to stdout

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–strip

Description:

Tables to strip (dump only structure of those tables)

Shortcut:

-s

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–force

Description:

Do not prompt if all options are defined

Shortcut:

-f

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

db:import¶

Imports database with mysql cli client according to database defined in local.xml

Usage:

$ n98-magerun.phar db:import [-c|--compression=&amp;quot;...&amp;quot;] [--only-command] [--only-if-empty] [filename]

Arguments¶

filename

Is required:

No

Is array:

No

Description:

Dump filename

Default:

n/a

Options¶

–compression

Description:

The compression of the specified file

Shortcut:

-c

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–only-command

Description:

Print only mysql command. Do not execute

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–only-if-empty

Description:

Imports only if database is empty

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

db:info¶

Dumps database informations

This command is useful to print all informations about the current configured database in app/etc/local.xml. It can print connection string for JDBC, PDO connections.

Usage:

$ n98-magerun.phar db:info

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

db:query¶

Executes an SQL query on the database defined in local.xml

Executes an SQL query on the current configured database. Wrap your SQL in single or double quotes.

If your query produces a result (e.g. a SELECT statement), the output of the mysql cli tool will be returned.

Requires MySQL CLI tools installed on your system.

Usage:

$ n98-magerun.phar db:query [--only-command] [query]

Arguments¶

query

Is required:

No

Is array:

No

Description:

SQL query

Default:

n/a

Options¶

–only-command

Description:

Print only mysql command. Do not execute

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Design Commands¶

design:demo-notice¶

Toggles demo store notice for a store view

Usage:

$ n98-magerun.phar design:demo-notice [--on] [--off] [--global] [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–global

Description:

Set value on default scope

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Dev Commands¶

dev:class:lookup¶

Resolves a grouped class name

Usage:

$ n98-magerun.phar dev:class:lookup type name

Arguments¶

type

Is required:

Yes

Is array:

No

Description:

The type of the class (helper|block|model)

Default:

n/a

name

Is required:

Yes

Is array:

No

Description:

The grouped class name

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:console¶

Opens PHP interactive shell with initialized Mage::app() &lt;comment&gt;(Experimental)&lt;/comment&gt;

Usage:

$ n98-magerun.phar dev:console

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:ide:phpstorm:meta¶

Generates meta data file for PhpStorm auto completion

Usage:

$ n98-magerun.phar dev:ide:phpstorm:meta [--stdout]

Options¶

–stdout

Description:

Print to stdout instead of file .phpstorm.meta.php

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:log¶

Toggle development log (system.log, exception.log)

Usage:

$ n98-magerun.phar dev:log [--on] [--off] [--global] [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–global

Description:

Set value on default scope

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:log:db¶

Turn on/off database query logging

Usage:

$ n98-magerun.phar dev:log:db [--on] [--off]

Options¶

–on

Description:

Force logging

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Disable logging

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:log:size¶

Get size of log file

Usage:

$ n98-magerun.phar dev:log:size [log_filename]

Arguments¶

log_filename

Is required:

No

Is array:

No

Description:

Name of log file.

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:module:create¶

Create and register a new magento module.

Usage:

$ n98-magerun.phar dev:module:create [--add-blocks] [--add-helpers] [--add-models] [--add-setup] [--add-all] [--modman] [--add-readme] [--add-composer] [--author-name[=&amp;quot;...&amp;quot;]] [--author-email[=&amp;quot;...&amp;quot;]] [--description[=&amp;quot;...&amp;quot;]] vendorNamespace moduleName [codePool]

Arguments¶

vendorNamespace

Is required:

Yes

Is array:

No

Description:

Namespace (your company prefix)

Default:

n/a

moduleName

Is required:

Yes

Is array:

No

Description:

Name of your module.

Default:

n/a

codePool

Is required:

No

Is array:

No

Description:

Codepool (local,community)

Default:

local

Options¶

–add-blocks

Description:

Adds blocks

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-helpers

Description:

Adds helpers

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-models

Description:

Adds models

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-setup

Description:

Adds SQL setup

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-all

Description:

Adds blocks, helpers and models

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–modman

Description:

Create all files in folder with a modman file.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-readme

Description:

Adds a readme.md file to generated module

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-composer

Description:

Adds a composer.json file to generated module

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–author-name

Description:

Author for readme.md or composer.json

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–author-email

Description:

Author for readme.md or composer.json

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–description

Description:

Description for readme.md or composer.json

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:module:dependencies:from¶

Show list of modules which depend on %s module

Usage:

$ n98-magerun.phar dev:module:dependencies:from [-a|--all] moduleName

Arguments¶

moduleName

Is required:

Yes

Is array:

No

Description:

Module to show dependencies

Default:

n/a

Options¶

–all

Description:

Show all dependencies (dependencies of dependencies)

Shortcut:

-a

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:module:dependencies:on¶

Show list of modules which given module depends on

Usage:

$ n98-magerun.phar dev:module:dependencies:on [-a|--all] moduleName

Arguments¶

moduleName

Is required:

Yes

Is array:

No

Description:

Module to show dependencies

Default:

n/a

Options¶

–all

Description:

Show all dependencies (dependencies of dependencies)

Shortcut:

-a

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:module:list¶

List all installed modules

Usage:

$ n98-magerun.phar dev:module:list [--codepool[=&amp;quot;...&amp;quot;]] [--status[=&amp;quot;...&amp;quot;]] [--vendor[=&amp;quot;...&amp;quot;]]

Options¶

–codepool

Description:

Show modules in a specific codepool

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–status

Description:

Show modules with a specific status

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–vendor

Description:

Show modules of a specified vendor

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:module:observer:list¶

Lists all registered observers

Usage:

$ n98-magerun.phar dev:module:observer:list [type]

Arguments¶

type

Is required:

No

Is array:

No

Description:

Observer type (global, admin, frontend)

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:module:rewrite:conflicts¶

Lists all magento rewrite conflicts

Lists all duplicated rewrites and tells you which class is loaded by Magento. The command checks class inheritance in order of your module dependencies.

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

Usage:

$ n98-magerun.phar dev:module:rewrite:conflicts [--log-junit=&amp;quot;...&amp;quot;]

Options¶

–log-junit

Description:

Log conflicts in JUnit XML format to defined file.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:module:rewrite:list¶

Lists all magento rewrites

Usage:

$ n98-magerun.phar dev:module:rewrite:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:profiler¶

Toggles profiler for debugging

Usage:

$ n98-magerun.phar dev:profiler [--on] [--off] [--global] [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–global

Description:

Set value on default scope

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:report:count¶

Get count of report files

Usage:

$ n98-magerun.phar dev:report:count

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:setup:script:attribute¶

Creates attribute script for a given attribute code

Usage:

$ n98-magerun.phar dev:setup:script:attribute entityType attributeCode

Arguments¶

entityType

Is required:

Yes

Is array:

No

Description:

Entity Type Code like catalog_product

Default:

n/a

attributeCode

Is required:

Yes

Is array:

No

Description:

Attribute Code

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:symlinks¶

Toggle allow symlinks setting

Usage:

$ n98-magerun.phar dev:symlinks [--on] [--off] [--global] [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–global

Description:

Set value on default scope

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:template-hints¶

Toggles template hints

Usage:

$ n98-magerun.phar dev:template-hints [--on] [--off] [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:template-hints-blocks¶

Toggles template hints block names

Usage:

$ n98-magerun.phar dev:template-hints-blocks [--on] [--off] [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:theme:duplicates¶

Find duplicate files (templates, layout, locale, etc.) between two themes.

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

Usage:

$ n98-magerun.phar dev:theme:duplicates [--log-junit=&amp;quot;...&amp;quot;] theme [originalTheme]

Arguments¶

theme

Is required:

Yes

Is array:

No

Description:

Your theme

Default:

n/a

originalTheme

Is required:

No

Is array:

No

Description:

Original theme to comapre. Default is &quot;base/default&quot;

Default:

base/default

Options¶

–log-junit

Description:

Log duplicates in JUnit XML format to defined file.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:theme:list¶

Lists all available themes

Usage:

$ n98-magerun.phar dev:theme:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:translate:admin¶

Toggle inline translation tool for admin

Usage:

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

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

dev:translate:shop¶

Toggle inline translation tool for shop

Usage:

$ n98-magerun.phar dev:translate:shop [--on] [--off] [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–on

Description:

Switch on

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Switch off

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Extension Commands¶

extension:download¶

Download magento-connect package

Requires Magento&#039;s mage shell script.
Does not work with Windows as operating system.

Usage:

$ n98-magerun.phar extension:download package

Arguments¶

package

Is required:

Yes

Is array:

No

Description:

Package to download

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

extension:install¶

Install magento-connect package

If the package could not be found a search for alternatives will be done. If alternatives could be found you can select the package to install.

Requires Magento&#039;s mage shell script.
Does not work with Windows as operating system.

Usage:

$ n98-magerun.phar extension:install package

Arguments¶

package

Is required:

Yes

Is array:

No

Description:

Package to install

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

extension:list¶

List magento connection extensions

Requires Magento&#039;s mage shell script.
Does not work with Windows as operating system.

Usage:

$ n98-magerun.phar extension:list [search]

Arguments¶

search

Is required:

No

Is array:

No

Description:

Search string

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

extension:upgrade¶

Upgrade magento-connect package

Requires Magento&#039;s mage shell script.
Does not work with Windows as operating system.

Usage:

$ n98-magerun.phar extension:upgrade package

Arguments¶

package

Is required:

Yes

Is array:

No

Description:

Package to upgrade

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Index Commands¶

index:list¶

Lists all magento indexes

Usage:

$ n98-magerun.phar index:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

index:reindex¶

Reindex a magento index by code

Index by indexer code. Code is optional. If you don&#039;t specify a code you can pick a indexer from a list.

$ n98-magerun.phar index:reindex [code]

Since 1.75.0 it&#039;s possible to run mutiple indexers by seperating code with a comma.

i.e.

$ n98-magerun.phar index:reindex catalog_product_attribute,tag_summary

If no index is provided as argument you can select indexers from menu by &quot;number&quot; like &quot;1,3&quot; for first and third indexer.

Usage:

$ n98-magerun.phar index:reindex [index_code]

Arguments¶

index_code

Is required:

No

Is array:

No

Description:

Code of indexer.

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

index:reindex:all¶

Reindex all magento indexes

Loops all magento indexes and triggers reindex.

Usage:

$ n98-magerun.phar index:reindex:all

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Local-config Commands¶

local-config:generate¶

Generates local.xml config

Generates the app/etc/local.xml.

The file &quot;app/etc/local.xml.template&quot; (bundles with Magento) must exist!
Currently the command does not validate anything you enter.
The command will not overwrite existing app/etc/local.xml files.

Usage:

$ n98-magerun.phar local-config:generate [db-host] [db-user] [db-pass] [db-name] [session-save] [admin-frontname]

Arguments¶

db-host

Is required:

No

Is array:

No

Description:

Database host

Default:

n/a

db-user

Is required:

No

Is array:

No

Description:

Database user

Default:

n/a

db-pass

Is required:

No

Is array:

No

Description:

Database password

Default:

n/a

db-name

Is required:

No

Is array:

No

Description:

Database name

Default:

n/a

session-save

Is required:

No

Is array:

No

Description:

Session storage adapter

Default:

n/a

admin-frontname

Is required:

No

Is array:

No

Description:

Admin front name

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Script Commands¶

script:repo:list¶

Lists all scripts in repository

You can organize your scripts in a repository. Simply place a script in folder /usr/local/share/n98-magerun/scripts or in your home dir in folder &lt;HOME&gt;/.n98-magerun/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-magerun.phar script:repo:list

Usage:

$ n98-magerun.phar script:repo:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

script:repo:run¶

Run script from repository

Usage:

$ n98-magerun.phar script:repo:run [script]

Arguments¶

script

Is required:

No

Is array:

No

Description:

Name of script in repository

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Standalone Commands¶

help¶

Displays help for a command

The &lt;info&gt;help&lt;/info&gt; command displays help for a given command:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun help list&lt;/info&gt;

You can also output the help in other formats by using the &lt;comment&gt;–format&lt;/comment&gt; option:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun help –format=xml list&lt;/info&gt;

To display the list of available commands, please use the &lt;info&gt;list&lt;/info&gt; command.

Usage:

$ n98-magerun.phar help [--xml] [--format=&amp;quot;...&amp;quot;] [--raw] [command_name]

Arguments¶

command_name

Is required:

No

Is array:

No

Description:

The command name

Default:

help

Options¶

–xml

Description:

To output help as XML

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–format

Description:

To output help in other formats

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–raw

Description:

To output raw command help

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

install¶

Install magento

Download Magento by a list of git repos and zip files (mageplus, magelte, official community packages).
Try to create database if it does not exist.
Installs Magento sample data if available (since version 1.2.0).
Starts Magento installer
Sets rewrite base in .htaccess file

Example of an unattended Magento CE 1.7.0.2 installation:

$ n98-magerun.phar install –dbHost=&quot;localhost&quot; –dbUser=&quot;mydbuser&quot; –dbPass=&quot;mysecret&quot; –dbName=&quot;magentodb&quot; –installSampleData=yes –useDefaultConfigParams=yes –magentoVersionByName=&quot;magento-ce-1.7.0.2&quot; –installationFolder=&quot;magento&quot; –baseUrl=&quot;http://magento.localdomain/&quot;

See it in action: http://youtu.be/WU-CbJ86eQc

Usage:

$ n98-magerun.phar install [--magentoVersion[=&amp;quot;...&amp;quot;]] [--magentoVersionByName[=&amp;quot;...&amp;quot;]] [--installationFolder[=&amp;quot;...&amp;quot;]] [--dbHost[=&amp;quot;...&amp;quot;]] [--dbUser[=&amp;quot;...&amp;quot;]] [--dbPass[=&amp;quot;...&amp;quot;]] [--dbName[=&amp;quot;...&amp;quot;]] [--installSampleData[=&amp;quot;...&amp;quot;]] [--useDefaultConfigParams[=&amp;quot;...&amp;quot;]] [--baseUrl[=&amp;quot;...&amp;quot;]] [--replaceHtaccessFile[=&amp;quot;...&amp;quot;]]

Options¶

–magentoVersion

Description:

Magento version

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–magentoVersionByName

Description:

Magento version name instead of order number

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–installationFolder

Description:

Installation folder

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbHost

Description:

Database host

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbUser

Description:

Database user

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbPass

Description:

Database password

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–dbName

Description:

Database name

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–installSampleData

Description:

Install sample data

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–useDefaultConfigParams

Description:

Use default installation parameters defined in the yaml file

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–baseUrl

Description:

Installation base url

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–replaceHtaccessFile

Description:

Generate htaccess file (for non vhost environment)

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

list¶

Lists commands

The &lt;info&gt;list&lt;/info&gt; command lists all commands:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list&lt;/info&gt;

You can also display the commands for a specific namespace:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list test&lt;/info&gt;

You can also output the information in other formats by using the &lt;comment&gt;–format&lt;/comment&gt; option:

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list –format=xml&lt;/info&gt;

It&#039;s also possible to get raw list of commands (useful for embedding command runner):

&lt;info&gt;php /home/cmuench/Workspaces/PHP/opensource/n98-magerun/bin/n98-magerun list –raw&lt;/info&gt;

Usage:

$ n98-magerun.phar list [--xml] [--raw] [--format=&amp;quot;...&amp;quot;] [namespace]

Arguments¶

namespace

Is required:

No

Is array:

No

Description:

The namespace name

Default:

n/a

Options¶

–xml

Description:

To output list as XML

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–raw

Description:

To output raw command list

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–format

Description:

To output list in other formats

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

open-browser¶

Open current project in browser &lt;comment&gt;(experimental)&lt;/comment&gt;

Usage:

$ n98-magerun.phar open-browser [store]

Arguments¶

store

Is required:

No

Is array:

No

Description:

Store code or ID

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

script¶

Runs multiple n98-magerun commands

Example:

# Set multiple config config:set &quot;web/cookie/cookie_domain&quot; example.com

# Set with multiline values with &quot;

&quot;: config:set &quot;general/store_information/address&quot; &quot;First line

Second line Third line&quot;

# This is a comment cache:flush

Optionally you can work with unix pipes.

$ echo &quot;cache:flush&quot; | n98-magerun-dev script

$ n98-magerun.phar script &lt; 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-magerun.phar script

config:set &quot;web/cookie/cookie_domain&quot; example.com cache:flush

# Run a shell script with &quot;!&quot; 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:

${magento.root} -&gt; Magento Root-Folder
${magento.version} -&gt; Magento Version i.e. 1.7.0.2
${magento.edition} -&gt; Magento Edition -&gt; Community or Enterprise
${magerun.version} -&gt; Magerun version i.e. 1.66.0
${php.version} -&gt; PHP Version
${script.file} -&gt; Current script file path
${script.dir} -&gt; Current script file dir

Variables can be passed to a script with &quot;–define (-d)&quot; option.

Example:

$ n98-magerun.phar script -d foo=bar filename

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

It&#039;s possible to define multiple values by passing more than one option.

Usage:

$ n98-magerun.phar script [-d|--define[=&amp;quot;...&amp;quot;]] [filename]

Arguments¶

filename

Is required:

No

Is array:

No

Description:

Script file

Default:

n/a

Options¶

–define

Description:

Defines a variable

Shortcut:

-d

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

shell¶

Runs n98-magerun as shell

Usage:

$ n98-magerun.phar shell

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

uninstall¶

Uninstall magento (drops database and empties current folder

Please be careful: This removes all data from your installation.

Usage:

$ n98-magerun.phar uninstall [-f|--force]

Options¶

–force

Description:

Force

Shortcut:

-f

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Sys Commands¶

sys:check¶

Checks Magento System

Checks missing files and folders
Security
PHP Extensions (Required and Bytecode Cache)
MySQL InnoDB Engine

Usage:

$ n98-magerun.phar sys:check

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:cron:history¶

Last executed cronjobs with status.

Usage:

$ n98-magerun.phar sys:cron:history

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:cron:list¶

Lists all cronjobs

Usage:

$ n98-magerun.phar sys:cron:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:cron:run¶

Runs a cronjob by job code

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

Usage:

$ n98-magerun.phar sys:cron:run [job]

Arguments¶

job

Is required:

No

Is array:

No

Description:

Job code

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:info¶

Prints infos about the current magento system.

Usage:

$ n98-magerun.phar sys:info

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:maintenance¶

Toggles maintenance mode.

Usage:

$ n98-magerun.phar sys:maintenance [--on] [--off]

Options¶

–on

Description:

Force maintenance mode

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–off

Description:

Disable maintenance mode

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:setup:compare-versions¶

Compare module version with core_resource table.

Compares module version with saved setup version in core_resource table and displays version mismatch.

Usage:

$ n98-magerun.phar sys:setup:compare-versions [--ignore-data]

Options¶

–ignore-data

Description:

Ignore data updates

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:setup:run¶

Runs all new setup scripts.

Runs all setup scripts (no need to call frontend). This command is useful if you update your system with enabled maintenance mode.

Usage:

$ n98-magerun.phar sys:setup:run

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:store:config:base-url:list¶

Lists all base urls

Usage:

$ n98-magerun.phar sys:store:config:base-url:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:store:list¶

Lists all installed store-views

Usage:

$ n98-magerun.phar sys:store:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:url:list¶

Get all urls.

Examples:

Create a list of product urls only:

$ n98-magerun.phar sys:url:list –add-products 4
Create a list of all products, categories and cms pages of store 4 and 5 separating host and path (e.g. to feed a jmeter csv sampler):

$ n98-magerun.phar sys:url:list –add-all 4,5 &#039;{host},{path}&#039; &gt; urls.csv
The &quot;linetemplate&quot; can contain all parts &quot;parse_url&quot; return wrapped in &#039;{}&#039;. &#039;{url}&#039; always maps the complete url and is set by default

Usage:

$ n98-magerun.phar sys:url:list [--add-categories] [--add-products] [--add-cmspages] [--add-all] [stores] [linetemplate]

Arguments¶

stores

Is required:

No

Is array:

No

Description:

Stores (comma-separated list of store ids)

Default:

n/a

linetemplate

Is required:

No

Is array:

No

Description:

Line template

Default:

{url}

Options¶

–add-categories

Description:

Adds categories

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-products

Description:

Adds products

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-cmspages

Description:

Adds cms pages

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–add-all

Description:

Adds categories, products and cms pages

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

sys:website:list¶

Lists all websites

Usage:

$ n98-magerun.phar sys:website:list

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Uml Commands¶

uml:generate¶

Generate UML diagramm

Usage:

$ n98-magerun.phar uml:generate classname

Arguments¶

classname

Is required:

Yes

Is array:

No

Description:

PHP class name

Default:

n/a

Options¶

–help

Description:

Display this help message.

Shortcut:

-h

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–quiet

Description:

Do not output any message.

Shortcut:

-q

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–verbose

Description:

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Shortcut:

-v|-vv|-vvv

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–version

Description:

Display this application version.

Shortcut:

-V

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–ansi

Description:

Force ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-ansi

Description:

Disable ANSI output.

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–no-interaction

Description:

Do not ask any interactive question.

Shortcut:

-n

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

–root-dir

Description:

Force magento root dir. No auto detection

Shortcut:

Accept value:

No

Is value required:

No

Is multiple:

No

Default:

n/a

Copyrights¶

netz98 new media GmbH

info@netz98.de

Haifa Allee 2 55128 Mainz Germany

Command Reference¶

Standalone Commands

Admin Commands

Cache Commands

Composer Commands

Config Commands

Customer Commands

Db Commands

Design Commands

Dev Commands

Extension Commands

Index Commands

Local-config Commands

Script Commands

Sys Commands

Indices and tables¶

Welcome to n98-magerun documentation!