The n98 magerun cli tools provides some handy tools to work with Magento from command line.
| Latest Release | |
| Development Branch |
DEVELOPMENT IN GIT BRANCH develop.
This software is only running with Magento 2. If you use Magento 1 please use another stable version (https://github.com/netz98/n98-magerun).
The tools will automatically be tested for multiple PHP versions (5.4, 5.5). It's currently running in various Linux distributions and Mac OS X. Microsoft Windows is not fully supported (some Commands like db:dump or install are excluded).
There are two ways to install the tools:
or if you have problems with SSL certificate:
You can make the .phar file executable.
If you want to use the command system wide you can copy it to /usr/local/bin.
All commands try to detect the current Magento root directory. If you have multiple Magento installations you must change your working directory to the preferred installation.
You can list all available commands by:
$ n98-magerun2.phar listIf you don't have the .phar file installed system wide you can call it with the PHP CLI interpreter:
php n98-magerun2.phar listGlobal config parameters:
- --root-dir
Force Magento root dir. No auto detection.
- --skip-config
Do not load any custom config.
- --skip-root-check
Do not check if n98-magerun2 runs as root.
- Downloads Composer (if not already installed)
- Downloads Magento 2.
- Tries to create database if it does not exist.
- Installs Magento sample data.
- Starts Magento installer
- Sets rewrite base in .htaccess file
Interactive installer:
Unattended installation:
Example of an unattended Magento CE 2.0.0.0 dev beta 1 installation:
Additionally, with --noDownload option you can install Magento working copy already stored in --installationFolder on the given database.
Provides info like the edition and version or the configured cache backends.
Lists all store views.
Lists all websites.
- Arguments:
path The config path value The config value
- Options:
--scope The config value's scope (default: "default" | Can be "default", "websites", "stores") --scope-id The config value's scope ID (default: "0") --encrypt Encrypt the config value using crypt key
- Arguments:
path The config path
- Options:
--scope The config value's scope (default, websites, stores) --scope-id The config value's scope ID --decrypt Decrypt the config value using local.xml's crypt key --update-script Output as update script lines --magerun-script Output for usage with config:set --format Output as json, xml or csv
- Help:
If path is not set, all available config items will be listed. path may contain wildcards (*)
Example:
- Arguments:
path The config path
- Options:
--scope The config scope (default, websites, stores) --scope-id The config value's scope ID --all Deletes all entries of a path (ignores --scope and --scope-id)
Cleans expired cache entries.
If you would like to clean only one cache type:
If you would like to clean multiple cache types at once:
If you would like to remove all cache entries use cache:flush
Run cache:list command to see all codes.
If no code is specified, all cache types will be disabled. Run cache:list command to see all codes.
If no code is specified, all cache types will be enabled. Run cache:list command to see all codes.
View the data for a particular attribute:
Generate Gift Card Pool """""""""""""""""
Generates a new gift card pool.
Create a Gift Card """""""""""""""""
You may specify a website ID or use the default. You may also optionally add an expiration date to the gift card using the --expires option. Dates should be in YYYY-MM-DD format.
View Gift Card Information """""""""""""""""
Remove a Gift Card """""""""""""""""
Compares module version with saved setup version in setup_module table and displays version mismatchs if found.
- If a filename with --log-junit option is set the tool generates an XML file and no output to stdout.
Changes the version of a module. This command is useful if you want to re-run an upgrade script again possibly for debugging. Alternatively you would have to alter the row in the database manually.
Opens PHP interactive shell with initialized Magento Admin-Store.
Variable $di is made available with a Magento\Framework\ObjectManagerInterface instance to allow creation of object instances.
If you need autocompletion for all n98-magerun commands you can start with "shell command".
Run multiple commands from a script file.
Example:
# Set multiple config
config:set "web/cookie/cookie_domain" example.com
# Set with multiline values with "\n"
config:set "general/store_information/address" "First line\nSecond line\nThird line"
# This is a comment
cache:flushOptionally you can work with unix pipes.
It is even possible to create executable scripts:
Create file test.magerun and make it executable (chmod +x test.magerun):
#!/usr/bin/env n98-magerun2.phar script
config:set "web/cookie/cookie_domain" example.com
cache:flush
# Run a shell script with "!" as first char
! ls -l
# Register your own variable (only key = value currently supported)
${my.var}=bar
# Let magerun ask for variable value - add a question mark
${my.var}=?
! echo ${my.var}
# Use resolved variables from n98-magerun in shell commands
! ls -l ${magento.root}/code/localPre-defined variables:
- ${magento.root} -> Magento Root-Folder
- ${magento.version} -> Magento Version i.e. 2.0.0.0
- ${magento.edition} -> Magento Edition -> Community or Enterprise
- ${magerun.version} -> Magerun version i.e. 2.1.0
- ${php.version} -> PHP Version
- ${script.file} -> Current script file path
- ${script.dir} -> Current script file dir
Variables can be passed to a script with "--define (-d)" option.
Example:
It's possible to define multiple values by passing more than one option.