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[="..."]] [--scope-id[="..."]] [--all] path

Arguments

path

Is required:
Yes
Is array:
No
Description:
The config path
Default:
n/a

Options

–scope

Description:
The config value's scope (default, websites, stores)

Shortcut:

Accept value:
No
Is value required:
No
Is multiple:
No
Default:
default

–scope-id

Description:
The config value'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 > 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 <info>path</info> is not set, all available config items will be listed. The <info>path</info> may contain wildcards (*). If <info>path</info> 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="..."] [--scope-id="..."] [--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's scope

Shortcut:

Accept value:
No
Is value required:
No
Is multiple:
No
Default:
n/a

–scope-id

Description:
The config value'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'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: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 "scope" and "scope-id" option.

Usage:

$ n98-magerun.phar config:set [--scope[="..."]] [--scope-id[="..."]] [--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's scope (default, websites, stores)

Shortcut:

Accept value:
No
Is value required:
No
Is multiple:
No
Default:
default

–scope-id

Description:
The config value'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'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