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