{"id":13720383,"url":"https://github.com/netz98/n98-magerun","last_synced_at":"2025-05-13T00:33:07.262Z","repository":{"id":4145665,"uuid":"5259347","full_name":"netz98/n98-magerun","owner":"netz98","description":"The swiss army knife for Magento developers, sysadmins and devops. The tool provides a huge set of well tested command line commands which save hours of work time. All commands are extendable by a module API.","archived":false,"fork":false,"pushed_at":"2025-05-06T22:56:41.000Z","size":39925,"stargazers_count":1442,"open_issues_count":90,"forks_count":399,"subscribers_count":118,"default_branch":"develop","last_synced_at":"2025-05-06T23:29:13.154Z","etag":null,"topics":["cli-app","magento","php"],"latest_commit_sha":null,"homepage":"http://magerun.net/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netz98.png","metadata":{"files":{"readme":"readme.rst","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"MIT-LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["sreichel"],"custom":["https://www.paypal.me/sv3n1"]}},"created_at":"2012-08-01T13:13:14.000Z","updated_at":"2025-05-06T22:55:29.000Z","dependencies_parsed_at":"2023-07-10T16:17:53.810Z","dependency_job_id":"ac260812-3fc8-48cf-94cd-e9ba16179dbf","html_url":"https://github.com/netz98/n98-magerun","commit_stats":{"total_commits":2349,"total_committers":153,"mean_commits":"15.352941176470589","dds":0.5568326947637292,"last_synced_commit":"011bd05da40c426e4d95f64b3b68c72eea02a010"},"previous_names":[],"tags_count":147,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netz98%2Fn98-magerun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netz98%2Fn98-magerun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netz98%2Fn98-magerun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netz98%2Fn98-magerun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netz98","download_url":"https://codeload.github.com/netz98/n98-magerun/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253850279,"owners_count":21973661,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli-app","magento","php"],"created_at":"2024-08-03T01:01:03.163Z","updated_at":"2025-05-13T00:33:07.226Z","avatar_url":"https://github.com/netz98.png","language":"PHP","funding_links":["https://github.com/sponsors/sreichel","https://www.paypal.me/sv3n1"],"categories":["Command Line","PHP","Tools"],"sub_categories":["Free"],"readme":"======================================\nnetz98 magerun CLI tools for Magento 1\n======================================\n\n.. image:: .github/doc/magerun-logo.png\n\nThe n98 magerun cli tools provides some handy tools to work with Magento from command line.\n\n.. image:: https://badges.gitter.im/netz98/magerun.svg\n   :target: https://gitter.im/netz98/magerun\n\n\nBuild Status\n------------\n\n+------------------------+-----------------------------------------------------------------------------------------------+\n| **Latest Release**     | .. image:: https://img.shields.io/maintenance/yes/2021.svg                                    |\n|                        | .. image:: https://travis-ci.org/netz98/n98-magerun.png?branch=master                         |\n|                        |    :target: https://travis-ci.org/netz98/n98-magerun                                          |\n|                        | .. image:: https://scrutinizer-ci.com/g/netz98/n98-magerun/badges/quality-score.png?b=master  |\n|                        |    :target: https://scrutinizer-ci.com/g/netz98/n98-magerun/                                  |\n|                        | .. image:: https://poser.pugx.org/n98/magerun/v/stable.png                                    |\n|                        |    :target: https://packagist.org/packages/n98/magerun                                        |\n+------------------------+-----------------------------------------------------------------------------------------------+\n| **Development Branch** | .. image:: https://travis-ci.org/netz98/n98-magerun.png?branch=develop                        |\n|                        |    :target: https://travis-ci.org/netz98/n98-magerun                                          |\n|                        | .. image:: https://circleci.com/gh/netz98/n98-magerun/tree/develop.svg?style=shield           |\n|                        |    :target: https://circleci.com/gh/netz98/n98-magerun/tree/develop                           |\n|                        | .. image:: https://scrutinizer-ci.com/g/netz98/n98-magerun/badges/quality-score.png?b=develop |\n|                        |    :target: https://scrutinizer-ci.com/g/netz98/n98-magerun/?branch=develop                   |\n|                        | .. image:: https://codecov.io/github/netz98/n98-magerun/coverage.svg?branch=develop           |\n|                        |    :target: https://codecov.io/github/netz98/n98-magerun?branch=develop                       |\n+------------------------+-----------------------------------------------------------------------------------------------+\n\nDevelopment is done in **develop** branch.\n\nThis software is only running with Magento 1.\n\nIf you use Magento 2 please use another stable version (https://github.com/netz98/n98-magerun2).\n\nCompatibility\n-------------\nThe tools will automatically be tested for multiple PHP versions. It's currently running in various Linux distributions and Mac OS X.\nMicrosoft Windows is not fully supported (some Commands like `db:dump` or `install` are excluded).\n\nWe test the tool agains this versions:\n\n- Magento 1.9.4.5 PHP 7.2\n- OpenMage LTS 20.0.3 PHP 7.3\n\nInstallation\n------------\n\nThere are three ways to install the tools:\n\nDownload and Install Phar File\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nDownload the latest stable N98-Magerun phar-file from the file-server_:\n\n.. code-block:: sh\n\n   wget https://files.magerun.net/n98-magerun.phar\n\nor if you prefer to use Curl:\n\n.. code-block:: sh\n\n   curl -O https://files.magerun.net/n98-magerun.phar\n\nVerify the download by comparing the SHA256 checksum with the one on the website at https://files.magerun.net/:\n\n.. code-block:: sh\n\n    shasum -a256 n98-magerun.phar\n\nIf it shows the same checksum as on the website, you downloaded the file successfully.\n\nNow you can make the phar-file executable:\n\n.. code-block:: sh\n\n    chmod +x ./n98-magerun.phar\n\nThe base-installation is now complete and you can verify it:\n\n.. code-block:: sh\n\n    ./n98-magerun.phar --version\n\nThe command should execute successfully and show you the version number of N98-Magerun like:\n\n.. code-block:: sh\n\n    n98-magerun version 2.3.0 by valantic CEC\n\nYou now have successfully installed Magerun! You can tailor the installation further like installing it system-wide and\nenable autocomplete - read on for more information about these and other features.\n\nIf you want to use the command system wide you can copy it to `/usr/local/bin`.\n\n.. code-block:: sh\n\n    sudo cp ./n98-magerun.phar /usr/local/bin/\n\n**Debian / suhosin:**\n\nOn some Debian systems with compiled in suhosin the phar extension must be added to a whitelist.\n\nAdd this to your php.ini file:\n\n.. code-block:: ini\n\n   suhosin.executor.include.whitelist=\"phar\"\n\n**You don't like the filename?**\n\nJust rename it to whatever you want. Or better: create an alias so that the original command name still works. This can\nbe useful if you exchange scripts that are making use of magerun with other users as the canonical name is\n`n98-magerun.phar`, Some common aliases amongst the user-base are `magerun` or just `mr` even.\n\n\n.. _file-server: https://files.magerun.net/\n\nInstall with Composer\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\nRequire Magerun within the Magento (or any other) project and you can then\nexecute it from the vendor’s bin folder:\n\n.. code-block:: sh\n\n    composer require n98/magerun\n    # ...\n    ./vendor/bin/n98-magerun --version\n    n98-magerun version 1.97.0 by netz98 new media GmbH\n\nAlternative source install:\n\nhttps://github.com/netz98/n98-magerun/wiki/Install-from-source-with-Composer\n\nInstall with Homebrew\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nFirst you need to have homebrew installed: http://brew.sh/\n\nInstall homebrew-php tap: https://github.com/Homebrew/homebrew-php#installation\n\nOnce homebrew and the tap are installed, you can install the tools with it:\n\n.. code-block:: sh\n\n    brew install n98-magerun\n\nYou can now use the tools:\n\n.. code-block:: sh\n\n    $ n98-magerun {command}\n\nUpdate\n------\n\nSince version 1.1.0 we deliver a self-update script within the phar file::\n\n   $ n98-magerun.phar self-update\n\nIf file was installed system wide do not forget \"sudo\".\n\nSee it in action: http://youtu.be/wMHpfKD9vjM\n\nAutocompletion\n--------------\n\nFiles for autocompletion with Magerun can be found inside the folder `res/autocompletion`, In\nthe following some more information about two specific ones (Bash, Phpstorm), there are\nmore (e.g. Fish, Zsh).\n\nBash\n\"\"\"\"\n\nBash completion is available pre-generated, all commands and their respective\noptions are availble on tab. To get completion for an otion type two dashes\n(\"--\") and then tab.\n\nTo install the completion files, copy **n98-magerun.phar.bash** to your bash\ncompatdir folder for autocompletion.\n\nOn my Ubuntu system this can be done with the following command:\n\n.. code-block:: sh\n\n   # cp res/autocompletion/bash/n98-magerun.phar.bash /etc/bash_completion.d\n\nThe concrete folder can be obtained via pkg-config:\n\n.. code-block:: sh\n\n    # pkg-config --variable=compatdir bash-completion\n\nDetailed information is available in the bash-completions FAQ: https://github.com/scop/bash-completion#faq\n\nPHPStorm\n\"\"\"\"\"\"\"\"\n\nA commandline tool autocompletion XML file for PHPStorm exists in subfolder **res/autocompletion/phpstorm**.\nCopy **n98_magerun.xml** into your phpstorm config folder.\n\nLinux and Mac: ~/.WebIde80/config/componentVersions\n\nYou can also add the XML content over settings menu.\nFor further instructions read this blog post: http://blog.jetbrains.com/webide/2012/10/integrating-composer-command-line-tool-with-phpstorm/\n\nUsage / Commands\n----------------\n\nAll commands try to detect the current Magento root directory.\nIf you have multiple Magento installations you must change your working directory to\nthe preferred installation.\n\nhttps://github.com/netz98/n98-magerun/wiki/Commands\n\nYou can list all available commands by::\n\n   $ n98-magerun.phar list\n\n\nIf you don't have the .phar file installed system wide you can call it with the PHP CLI interpreter::\n\n   php n98-magerun.phar list\n\n\nGlobal config parameters:\n\n  --root-dir\n      Force Magento root dir. No auto detection.\n  --skip-config\n      Do not load any custom config.\n  --skip-root-check\n      Do not check if n98-magerun runs as root.\n  --developer-mode\n      Instantiate Magento in Developer Mode\n\n\nOpen Shop in Browser\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar open-browser [store]\n\nCustomer Info\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLoads basic customer info by email address.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar  customer:info [email] [website]\n\n\nCreate customer\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCreates a new customer/user for shop frontend.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar  customer:create [email] [password] [firstname] [lastname] [website]\n\nExample:\n\n.. code-block:: sh\n\n  $ n98-magerun.phar customer:create foo@example.com password123 John Doe base\n\nDelete Customers\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nThis will delete a customer by a given Id/Email, delete all customers or delete all customers in a range of Ids.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar delete [-a|--all] [-f|--force] [-r|--range] [id]\n\nExamples:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar customer:delete 1                   # Will delete customer with Id 1\n   $ n98-magerun.phar customer:delete mike@example.com    # Will delete customer with that email\n   $ n98-magerun.phar customer:delete --all               # Will delete all customers\n   $ n98-magerun.phar customer:delete --range             # Will prompt for start and end Ids for batch deletion\n\nGenerate Dummy Customers\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nGenerate dummy customers. You can specify a count and a locale.\n\n.. code-block:: sh\n\n  $ n98-magerun.phar customer:create:dummy count locale [website]\n\n\nSupported Locales:\n\n    * cs_CZ\n    * ru_RU\n    * bg_BG\n    * en_US\n    * it_IT\n    * sr_RS\n    * sr_Cyrl_RS\n    * sr_Latn_RS\n    * pl_PL\n    * en_GB\n    * de_DE\n    * sk_SK\n    * fr_FR\n    * es_AR\n    * de_AT\n\nList Customers\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nList customers. The output is limited to 1000 (can be changed by overriding config).\nIf search parameter is given the customers are filtered (searchs in firstname, lastname and email).\n\n.. code-block:: sh\n\n   $ n98-magerun.phar  customer:list [--format[=\"...\"]] [search]\n\nChange customer password\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar customer:change-password [email] [password] [website]\n\n- Website parameter must only be given if more than one websites are available.\n\nPrint database information\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:info [setting]\n\n**Arguments**\n\n    setting               Only output value of named setting\n\n\nDump database\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nDumps configured Magento database with `mysqldump`.\n\n* Requires MySQL CLI tools\n\n**Arguments**\n\n    filename        Dump filename\n\n**Options**\n\n  --add-time\n        Adds time to filename (only if filename was not provided)\n\n  --compression (-c)\n        Compress the dump file using one of the supported algorithms\n\n  --only-command\n        Print only mysqldump command. Do not execute\n\n  --print-only-filename\n        Execute and prints not output except the dump filename\n\n  --no-single-transaction\n        Do not use single-transaction (not recommended, this is blocking)\n\n  --human-readable\n        Use a single insert with column names per row.\n\n  --stdout\n        Dump to stdout\n\n  --strip\n        Tables to strip (dump only structure of those tables)\n\n  --force (-f)\n        Do not prompt if all options are defined\n\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:dump\n\nOnly the mysqldump command:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:dump --only-command [filename]\n\nOr directly to stdout:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:dump --stdout\n\nUse compression (gzip cli tool has to be installed):\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:dump --compression=\"gzip\"\n\nStripped Database Dump\n^^^^^^^^^^^^^^^^^^^^^^\n\nDumps your database and excludes some tables. This is useful i.e. for development.\n\nSeparate each table to strip by a space.\nYou can use wildcards like * and ? in the table names to strip multiple tables.\nIn addition you can specify pre-defined table groups, that start with an @\nExample: \"dataflow_batch_export unimportant_module_* @log\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:dump --strip=\"@stripped\"\n\nAvailable Table Groups:\n\n* @admin Admin tables\n* @log Log tables\n* @dataflowtemp Temporary tables of the dataflow import/export tool\n* @importexporttemp Temporary tables of the Import/Export module\n* @stripped Standard definition for a stripped dump (logs, sessions, dataflow and importexport)\n* @sales Sales data (orders, invoices, creditmemos etc)\n* @customers Customer data\n* @trade Current trade data (customers and orders). You usally do not want those in developer systems.\n* @search Search related tables (catalogsearch_)\n* @development Removes logs, sessions, trade data and admin users so developers do not have to work with real customer data or admin user accounts\n* @idx Tables with _idx suffix and index event tables\n\nExtended: https://github.com/netz98/n98-magerun/wiki/Stripped-Database-Dumps\n\nSee it in action: http://youtu.be/ttjZHY6vThs\n\nDatabase Import\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nImports an SQL file with mysql cli client into current configured database.\n\n* Requires MySQL CLI tools\n\nArguments:\n    filename        Dump filename\n\nOptions:\n     --compression (-c)       The compression of the specified file\n     --only-command           Print only mysql command. Do not execute\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:dump\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:import [--only-command] [filename]\n\nUse decompression (gzip cli tool has to be installed):\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:import --compression=\"gzip\" [filename]\n\nOptimize \"human readable\" dump:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:import --optimize [filename]\n\nDatabase Console / MySQL Client\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nOpens the MySQL console client with your database settings from local.xml\n\n* Requires MySQL CLI tools\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:console [--no-auto-rehash]\n\n  --no-auto-rehash\n      synonym for calling *mysql* client with the -A parameter to skip hashing for object auto-completion.\n\nDatabase Create\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCreate currently configured database\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:create\n\nDatabase Drop\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nDrops the database configured in local.xml.\n\n* Requires MySQL CLI tools\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:drop  [-f|--force]\n\nDatabase Query\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nExecutes an SQL query on the current configured database. Wrap your SQL in\nsingle or double quotes.\n\nIf your query produces a result (e.g. a SELECT statement), the output of the\nmysql cli tool will be returned.\n\n* Requires MySQL CLI tools\n\nArguments:\n    query        SQL query\n\nOptions:\n     --only-command           Print only mysql command. Do not execute\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:query [--only-command] [query]\n\n\nDatabase Variables\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nSee the most important MySQL variables of your Magento instance.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar db:variables [--format[=\"...\"]] [--rounding[=\"...\"]] [--no-description] [search]\n\nDatabase Status\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nThis command is useful to print important server status information about the current database.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar [--format[=\"...\"]] [--rounding[=\"...\"]] [--no-description] [search]\n\nDump Media folder\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCreates a ZIP archive with media folder content.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar media:dump [--strip] [filename]\n\nIf strip option is set, the following folders are excluded:\n\n* js (combined js files)\n* css (combined css files)\n* catalog/product/cache\n\nCreate Gift Card Pool\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCreates a new giftcard pool\n\n.. code-block:: sh\n\n   $ n98-magerun.phar giftcard:pool:generate\n\nCreate a Gift Card\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar giftcard:create [--website[=\"...\"]] amount\n\nYou may specify a website ID or use the default\n\nView Gift Card Information\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar giftcard:info [--format[=\"...\"]] code\n\nRemove a Gift Card\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar giftcard:remove code\n\nList Indexes\n\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar index:list [--format[=\"...\"]]\n\nReindex a Index\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nIndex by indexer code. Code is optional. If you don't specify a code you can pick a indexer from a list.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar index:reindex [code]\n\n\nSince 1.75.0 it's possible to run mutiple indexers by seperating code with a comma.\n\ni.e.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar index:reindex catalog_product_attribute,tag_summary\n\nIf no index is provided as argument you can select indexers from menu by \"number\" like \"1,3\" for first and third\nindexer.\n\nReindex All\n\"\"\"\"\"\"\"\"\"\"\"\n\nLoops all Magento indexes and triggers reindex.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar index:reindex:all\n\nList Enterprise Mview Changelog Indexes\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists the Mview indexers available, as well as their current version and how many are in the changelog queue .\n\n.. code-block:: sh\n\n   $ n98-magerun.phar index:list:mview [--format[=\"...\"]]\n\nReindex an Enterprise Mview Changelog Index\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nIndex by Mview table code. This will ignore all locks and trigger the changelog indexer.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar index:reindex:mview [table_code]\n\n\nGenerate local.xml file\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar local-config:generate\n\nConfig Dump\n\"\"\"\"\"\"\"\"\"\"\"\n\nDumps merged XML configuration to stdout. Useful to see all the XML.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:dump [xpath]\n\nExamples\n^^^^^^^^\n\nConfig of catalog module:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:dump global/catalog\n\n\nSee module order in XML:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:dump modules\n\n\nWrite output to file:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:dump \u003e extern_file.xml\n\n\nSet Config\n\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:set [--scope[=\"...\"]] [--scope-id[=\"...\"]] [--encrypt] [--force] path value\n\nArguments:\n    path        The config path\n    value       The config value\n\nOptions:\n    --scope     The config value's scope (default: \"default\" | Can be \"default\", \"websites\", \"stores\")\n    --scope-id  The config value's scope ID (default: \"0\")\n    --encrypt   Encrypt the config value using local.xml's crypt key\n    --force     Allow creation of non-standard scope-id's for websites and stores\n\nGet Config\n\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:get [--scope=\"...\"] [--scope-id=\"...\"] [--decrypt] [--format[=\"...\"]] [path]\n\nArguments:\n    path        The config path\n\nOptions:\n    --scope             The config value's scope (default, websites, stores)\n    --scope-id          The config value's scope ID\n    --decrypt           Decrypt the config value using local.xml's crypt key\n    --update-script     Output as update script lines\n    --magerun-script    Output for usage with config:set\n    --format            Output as json, xml or csv\n\nHelp:\n    If path is not set, all available config items will be listed. path may contain wildcards (*)\n\nExample:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:get web/* --magerun-script\n\nDelete Config\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar config:delete [--scope[=\"...\"]] [--scope-id[=\"...\"]] [--all] [--force] path\n\nArguments:\n    path        The config path\n\nOptions:\n    --scope     The config scope (default, websites, stores)\n    --scope-id  The config value's scope ID\n    --all       Deletes all entries of a path (ignores --scope and --scope-id)\n    --force     Allow deletion of non-standard scope-id's for websites and stores\n\nConfig Search\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nSearch system configuration descriptions.\n\n .. code-block:: sh\n\n   $ n98-magerun.phar config:search text\n\n\nList Magento cache status\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cache:list\n\nClean Magento cache\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCleans expired cache entries.\n\nIf you would like to clean only one cache type:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cache:clean [--reinit] [--no-reinit] [\u003ccode\u003e]\n\nIf you would like to clean multiple cache types at once:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cache:clean [--reinit] [--no-reinit] [\u003ccode\u003e] [\u003ccode\u003e] ...\n\nOptions:\n    --reinit Reinitialise the config cache after cleaning (Default)\n    --no-reinit Don't reinitialise the config cache after cleaning. This will override --reinit.\n\nIf you would like to remove all cache entries use `cache:flush`\n\nRun `cache:list` command to see all codes.\n\nRemove all cache entries\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nFlush the entire cache.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cache:flush [--reinit] [--no-reinit]\n\nOptions:\n    --reinit Reinitialise the config cache after flushing (Default)\n    --no-reinit Don't reinitialise the config cache after flushing. This will override --reinit.\n\nList Magento caches\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cache:list [--format[=\"...\"]]\n\nDisable Magento cache\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cache:disable [code]\n\nIf no code is specified, all cache types will be disabled.\nRun `cache:list` command to see all codes.\n\nEnable Magento cache\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cache:enable [code]\n\nIf no code is specified, all cache types will be enabled.\nRun `cache:list` command to see all codes.\n\nCache Report\n\"\"\"\"\"\"\"\"\"\"\"\"\n\nThis command let you investigate what's stored inside your cache.\nIt prints out a table with cache IDs.\n\n.. code-block:: sh\n\n   $ cache:report [-t|--tags] [-m|--mtime] [--filter-id[=\"...\"]] [--filter-tag[=\"...\"]] [--fpc]\n\nCache View\n\"\"\"\"\"\"\"\"\"\"\n\nPrints stored cache entry by ID.\n\n.. code-block:: sh\n\n   $ cache:view [--unserialize] [--fpc] id\n\nIf value is serialized you can force a pretty output with --unserialize option.\n\nToggle CMS Block\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nToggle \"is_active\" on a cms block\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cms:block:toggle [block_id]\n\n\"block_id\" can be an entity id or an \"identifier\"\n\nList CMS Blocks\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nList all CMS blocks\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cms:block:list [--format[=\"...\"]]\n\nDemo Notice\n\"\"\"\"\"\"\"\"\"\"\"\n\nToggle demo store notice\n\n.. code-block:: sh\n\n   $ n98-magerun.phar design:demo-notice [store_code]\n\nList admin users\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:list [--format[=\"...\"]]\n\nCreate admin user\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:create [username] [email] [password] [firstname] [lastname] [role]\n\n\nChange admin user password\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:change-password [username] [password]\n\nDelete admin user\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:delete [email|username] [-f]\n\nID can be e-mail or username. The command will attempt to find the user by username first and if it cannot be found it\nwill attempt to find the user by e-mail. If ID is omitted you will be prompted for it. If the force parameter \"-f\" is\nomitted you will be prompted for confirmation.\n\nToggle admin user active state\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:change-status [--activate] [--deactivate] [email|username]\n\nToggles the active status of an backend user. ID can be e-mail or username. The command will attempt to find the\nuser by username first and if it cannot be found it will attempt to find the user by e-mail. If ID is omitted you\nwill be prompted for it.\n\nLock admin user\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:lock [username] [lifetime]\n\nLocks an admin user for the number of days specified in `[lifetime]`. If not provided, the lifetime will default to\n31 days.\n\nLock all admin users\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:lockdown [lifetime] [--dry-run]\n\nLocks all admin users in the system for the number of days specified in `[lifetime]`. As above, if not provided it will\ndefault to 31 days.\n\nUse with caution! Use the `--dry-run` option to test first.\n\nUnlock admin user\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:user:unlock [username]\n\nReleases the password lock on an admin (leave blank to unlock all admins).\n\nDisable admin notifications\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nToggle admin notifications.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar admin:notifications\n\nMaintenance mode\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nIf no option is provided it toggles the mode on every call.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:maintenance [--on] [--off]\n\nMagento system info\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nProvides info like the edition and version or the configured cache backends.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:info [key]\n\nPrint only one value like the version.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:info version\n\nMagento Stores\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists all store views.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:store:list [--format[=\"...\"]]\n\nMagento Store Config - BaseURLs\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists base urls for each store.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:store:config:base-url:list [--format[=\"...\"]]\n\nMagento Websites\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists all websites.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:website:list [--format[=\"...\"]]\n\nList Cronjobs\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists all cronjobs defined in config.xml files.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:cron:list [--format[=\"...\"]]\n\nRun Cronjob\n\"\"\"\"\"\"\"\"\"\"\"\n\nRuns a cronjob by code.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:cron:run [--schedule] [job]\n\nIf no `job` argument is passed you can select a job from a list.\nSee it in action: http://www.youtube.com/watch?v=QkzkLgrfNaM\nIf option schedule is present, cron is not launched, but just scheduled immediately in magento crontab.\n\nCronjob History\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLast executed cronjobs with status.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:cron:history [--format[=\"...\"]] [--timezone[=\"...\"]]\n\nList URLs\n\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:url:list [--add-categories] [--add-products] [--add-cmspages] [--add-all] [stores] [linetemplate]\n\nExamples:\n\n- Create a list of product urls only:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:url:list --add-products 4\n\n- 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):\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:url:list --add-all 4,5 '{host},{path}' \u003e urls.csv\n\n- The \"linetemplate\" can contain all parts \"parse_url\" return wrapped in '{}'. '{url}' always maps the complete url and is set by default\n\n\nRun Setup Scripts\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nRuns all setup scripts (no need to call frontend).\nThis command is useful if you update your system with enabled maintenance mode.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:setup:run\n\nRun Setup Scripts Incrementally\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nRuns setup scripts incrementally. (no need to call frontend).\nThis command runs each new setup script individually in order to increase the transparency of the setup resource system, and reduce the chances of a PHP failure creating an invalid database state.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:setup:incremental [--stop-on-error]\n\nCompare Setup Versions\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCompares module version with saved setup version in `core_resource` table and displays version mismatch.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:setup:compare-versions [--ignore-data] [--errors-only] [--log-junit=\"...\"] [--format[=\"...\"]]\n\n* If a filename with `--log-junit` option is set the tool generates an XML file and no output to *stdout*.\n* If status errors are found this will return an exit status of 1 rather than 0, making it perfect for hooking into deployment scripts.\n\nChange Setup Version\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nChanges the version of one or all module resource setups. This command is useful if you want to re-run an upgrade\nscript again possibly due to debugging. Alternatively you would have to alter the row in the database manually.\n\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:setup:change-version module version [setup]\n\nSetup argument default is \"all resources\" for the given module.\n\nRemove Setup Version\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nRemoves the entry for one or all module resource setups. This command is useful if you want to re-run an install\nscript again possibly due to debugging. Alternatively you would have to remove the row from the database manually.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:setup:remove module [setup]\n\nSetup argument default is \"all resources\" for the given module.\n\nSystem Check\n\"\"\"\"\"\"\"\"\"\"\"\"\n\n- Checks missing files and folders\n- Security\n- PHP Extensions (Required and Bytecode Cache)\n- MySQL InnoDB Engine\n\n.. code-block:: sh\n\n   $ n98-magerun.phar sys:check\n\nCMS: Toggle Banner\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nHide/Show CMS Banners\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cms:banner:toggle \u003cbanner_id\u003e\n\nCMS: Publish a page\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nPublishes a page by page id and revision.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar cms:page:publish \u003cpage_id\u003e \u003crevision_id\u003e\n\nUseful to automatically publish a page by a cron job.\n\nInteractive Development Console\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nOpens PHP interactive shell with initialized Magento Admin-Store.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:console\n\nSee it in action: http://www.youtube.com/watch?v=zAWpRpawTGc\n\nThe command is only available for PHP 5.4 users.\n\nCSS Merging\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nToggle CSS merging settings of a store\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:merge-css [store_code]\n\nJS Merging\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nToggle JS merging settings of a store\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:merge-js [store_code]\n\nTemplate Hints\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nToggle debug template hints settings of a store\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:template-hints [store_code]\n\nTemplate Hints Blocks\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nToggle debug template hints blocks settings of a store\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:template-hints-blocks [store_code]\n\nInline Translation\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nToggle settings for shop frontend:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:translate:shop [store_code]\n\nToggle for admin area:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:translate:admin\n\nExport Inline Translation\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nExports saved database translation data into a file.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:translate:export [locale] [filename]\n\nProfiler\n\"\"\"\"\"\"\"\"\n\nToggle profiler for debugging a store:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:profiler [--on] [--off] [--global] [store]\n\nEmail Template Usage\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nDisplay a report of use transactional email templates:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:email-template:usage --format[=FORMAT]\n\nDevelopment Logs\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nActivate/Deactivate system.log and exception.log for a store:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:log [--on] [--off] [--global] [store]\n\nShow size of a log file:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:log:size [--human] [log_filename]\n\nActivate/Deactivate MySQL query logging via lib/Varien/Db/Adapter/Pdo/Mysql.php\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:log:db [--on] [--off]\n\nSetup Script Generation\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nGenerate Script for attributes:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:setup:script:attribute entityType attributeCode\n\ni.e.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:setup:script:attribute catalog_product color\n\nCurrently only *catalog_product* entity type is supported.\n\nEAV Attributes\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nList all EAV attributes:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar eav:attribute:list [--filter-type[=\"...\"]] [--add-source] [--add-backend] [--format[=\"...\"]]\n\nView the data for a particular attribute:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar eav:attribute:view [--format[=\"...\"]] entityType attributeCode\n\nRemove an attribute:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar eav:attribute:remove entityType attributeCode\n\nYou can also remove multiple attributes in one go if they are of the same type\n\n.. code-block:: sh\n\n   $ n98-magerun.phar eav:attribute:remove entityType attributeCode1 attributeCode2 ... attributeCode10\n\n\nDevelopment IDE Support\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n**PhpStorm Code Completion** -\u003e Meta file generation.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:ide:phpstorm:meta [--meta-version=(old|2016.2+)] [--stdout]\n\nGenerates meta data file for PhpStorm auto completion (default version : 2016.2+)\n\nReports\n\"\"\"\"\"\"\"\n\nPrints count of reports in var/reports folder.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:report:count\n\nResolve/Lookup Class Names\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nResolves the given type and grouped class name to a class name, useful for debugging rewrites.\n\nIf the resolved class doesn't exist, an info message will be displayed.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:class:lookup \u003cblock|model|helper\u003e \u003cname\u003e\n\nExample:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:class:lookup model catalog/product\n\nToggle Symlinks\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nAllow usage of symlinks for a store-view:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:symlinks [--on] [--off] [--global] [store_code]\n\nGlobal scope can be set by not permitting store_code parameter:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:symlinks\n\nCreate Module Skeleton\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCreates an empty module and registers it in current Magento shop:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:create [--add-controllers] [--add-blocks] [--add-helpers] [--add-models] [--add-setup] [--add-all] [--modman] [--add-readme] [--add-composer] [--author-name[=\"...\"]] [--author-email[=\"...\"]] [--description[=\"...\"]] vendorNamespace moduleName [codePool]\n\nCode-Pool defaults to `local`.\n\n\nExample:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:create MyVendor MyModule\n\n\n* `--modman` option creates a new folder based on `vendorNamespace` and `moduleName` argument.\nRun this command inside your `.modman` folder.\n\n* --add-all option add blocks, helpers and models.\n\n* --add-readme Adds a readme.md file to your module.\n\n* --add-composer Adds a composer.json to your module.\n\n* --author-email Author email for composer.json file.\n\n* --author-name Author name for composer.json file.\n\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:code:model:method [modelName]\n\nEnable/Disable Module in Declaration\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nEnable or disable a module in `app/etc/modules/*.xml` by name or codePool:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:enable [--codepool=\"...\"] moduleName\n   $ n98-magerun.phar dev:module:disable [--codepool=\"...\"] moduleName\n\nExamples:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:disable MyVendor_MyModule\n   $ n98-magerun.phar dev:module:disable --codepool=\"community\"\n\n\n.. hint::\n\n   If `--codepool` option is specified all modules in the codepool are affected.\n\nList Modules\n\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists all installed modules with codepool and version\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:list  [--codepool[=\"...\"]] [--status[=\"...\"]] [--vendor=[=\"...\"]] [--format[=\"...\"]]\n\nRewrite List\n\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists all registered class rewrites.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:rewrite:list [--format[=\"...\"]]\n\nRewrite Conflicts\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists all duplicated rewrites and tells you which class is loaded by Magento.\nThe command checks class inheritance in order of your module dependencies.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:rewrite:conflicts [--log-junit=\"...\"]\n\n* If a filename with `--log-junit` option is set the tool generates an XML file and no output to *stdout*.\n\nModule Dependencies\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nShow list of modules which given module depends on\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:dependencies:on [-a|--all] [--format[=\"...\"]] moduleName\n\nShow list of modules which depend from module\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:dependencies:from [-a|--all] [--format[=\"...\"]] moduleName\n\nObserver List\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nLists all registered observer by type.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:module:observer:list [type]\n\nType is one of \"adminhtml\", \"global\", \"frontend\".\n\nTheme List\n\"\"\"\"\"\"\"\"\"\"\n\nLists all frontend themes\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:theme:list [--format[=\"...\"]]\n\n\nFind Duplicates in your theme\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nFind duplicate files (templates, layout, locale, etc.) between two themes.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:theme:duplicates [--log-junit=\"...\"] theme [originalTheme]\n\n* `originTheme` default is \"base/default\".\n\nExample:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar dev:theme:duplicates default/default\n\n\n* If a filename with `--log-junit` option is set the tool generates an XML file and no output to *stdout*.\n\nCreate dummy Category\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar category:create:dummy\n\nCreate dummy categories with all default vanilla magento or your custom values.\n\n**Interactive mode** or via **shell arguments** or mixed.\n\n+------------------------------+---------------------------------------------------------------------------------------------+--------------------------------------------------+\n| Arguments                    | Description                                                                                 | Accepted Values                                  |\n+------------------------------+---------------------------------------------------------------------------------------------+--------------------------------------------------+\n| `store-id`                   | Id of Store to create categories (default: 1)                                               | only integer                                     |\n+------------------------------+---------------------------------------------------------------------------------------------+--------------------------------------------------+\n| `category-number`            | Number of categories to create (default: 1)                                                 | only integer                                     |\n+------------------------------+---------------------------------------------------------------------------------------------+--------------------------------------------------+\n| `children-categories-number` | Number of children for each category created (default: 0 - use '-1' for random from 0 to 5) | only integer or -1 for random number from 0 to 5 |\n+------------------------------+---------------------------------------------------------------------------------------------+--------------------------------------------------+\n| `category-name-prefix`       | Category Name Prefix (default: 'My Awesome Category')                                       | any                                              |\n+------------------------------+---------------------------------------------------------------------------------------------+--------------------------------------------------+\n\nCreate dummy Dropdown Attribute Values\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n.. code-block:: sh\n\n   $ n98-magerun.phar eav:attribute:create-dummy-values\n\nCreate dummy attribute values (ONLY FOR DROPDOWN ATTRIBUTE)\n\n**Interactive mode** or via **shell arguments** or mixed.\n\n+------------------------------+----------------------------------------------+--------------------------------------------------------------+\n| Arguments                    | Description                                  | Accepted Values                                              |\n+------------------------------+----------------------------------------------+--------------------------------------------------------------+\n| `locale`                     | Locale value in ISO standard like en_US      | only string                                                  |\n+------------------------------+----------------------------------------------+--------------------------------------------------------------+\n| `attribute-id`               | Attribute ID to add values                   | only integer                                                 |\n+------------------------------+----------------------------------------------+--------------------------------------------------------------+\n| `values-type`                | Types of Values to create (default int)      | `int`\u003cbr /\u003e`string`\u003cbr /\u003e`color`\u003cbr /\u003e`size`\u003cbr /\u003e`designer` |\n+------------------------------+----------------------------------------------+--------------------------------------------------------------+\n| `values-number`              | Number of Values to create (default 1)       | only integer                                                 |\n+------------------------------+----------------------------------------------+--------------------------------------------------------------+\n\nList Extensions\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nList and find connect extensions by a optional search string:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar extension:list [--format[=\"...\"]] \u003csearch\u003e\n\n* Requires Magento's `mage` shell script.\n* Does not work with Windows as operating system.\n\nInstall Extensions\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nInstalls a connect extension by package key:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar extension:install \u003cpackage_key\u003e\n\nIf the package could not be found a search for alternatives will be done.\nIf alternatives could be found you can select the package to install.\n\n* Requires Magento's `mage` shell script.\n* Does not work with Windows as operating system.\n\nDownload Extensions\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nDownloads connect extensions by package key:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar extension:download \u003csearch\u003e\n\n* Requires Magento's `mage` shell script.\n* Does not work with Windows as operating system.\n\nUpgrade Extensions\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nUpgrade connect extensions by package key:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar extension:upgrade \u003csearch\u003e\n\n* Requires Magento's `mage` shell script.\n* Does not work with Windows as operating system.\n\nMagento Installer\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nSince version 1.1.0 we deliver a Magento installer which does the following:\n\n* Downloads Magento by a list of git repos and zip files (mageplus, magelte, official community packages).\n* Tries to create database if it does not exist.\n* Installs Magento sample data if available (since version 1.2.0).\n* Starts Magento installer\n* Sets rewrite base in .htaccess file\n\nInteractive installer:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar install\n\nUnattended installation:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar install [--magentoVersion[=\"...\"]] [--magentoVersionByName[=\"...\"]] [--installationFolder[=\"...\"]] [--dbHost[=\"...\"]] [--dbUser[=\"...\"]] [--dbPass[=\"...\"]] [--dbName[=\"...\"]] [--installSampleData[=\"...\"]] [--useDefaultConfigParams[=\"...\"]] [--baseUrl[=\"...\"]] [--replaceHtaccessFile[=\"...\"]]\n\nExample of an unattended Magento CE 1.7.0.2 installation:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar install --dbHost=\"localhost\" --dbUser=\"mydbuser\" --dbPass=\"mysecret\" --dbName=\"magentodb\" --installSampleData=yes --useDefaultConfigParams=yes --magentoVersionByName=\"magento-ce-1.7.0.2\" --installationFolder=\"magento\" --baseUrl=\"http://magento.localdomain/\"\n\nAdditionally, with --noDownload option you can install Magento working copy already stored in --installationFolder on\nthe given database.\n\nSee it in action: http://youtu.be/WU-CbJ86eQc\n\n\nMagento Uninstaller\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nUninstalls Magento: Drops your database and recursive deletes installation folder.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar uninstall [-f|--force] [--installationFolder[=\"...\"]]\n\n**Please be careful: This removes all data from your installation.**\n\n--installationFolder is required and if you do not enter it you will be prompted for it. This should be your project\nroot, not the Magento root. For example, If your project root is /var/www/site and Magento src is located at\n/var/www/site/htdocs, you should pass /var/www/site to the command, or if you are currently in that particular directory\nyou can just pass \".\" Eg:\n\n.. code-block:: sh\n\n   $ cd /var/www/site\n   $ n98-magerun.phar uninstall --installationFolder \".\" -f\n\nIf you omit the -f, you will be prompted for confirmation.\n\nn98-magerun Shell\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nIf you need autocompletion for all n98-magerun commands you can start with \"shell command\".\n\n.. code-block:: sh\n\n   $ n98-magerun.phar shell\n\nn98-magerun Script\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nRun multiple commands from a script file.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar script [-d|--define[=\"...\"]] [--stop-on-error] [filename]\n\nExample:\n\n.. code-block::\n\n   # Set multiple config\n   config:set \"web/cookie/cookie_domain\" example.com\n\n   # Set with multiline values with \"\\n\"\n   config:set \"general/store_information/address\" \"First line\\nSecond line\\nThird line\"\n\n   # This is a comment\n   cache:flush\n\n\nOptionally you can work with unix pipes.\n\n.. code-block:: sh\n\n   $ echo \"cache:flush\" | n98-magerun-dev script\n\n.. code-block:: sh\n\n   $ n98-magerun.phar script \u003c filename\n\nIt is even possible to create executable scripts:\n\nCreate file `test.magerun` and make it executable (`chmod +x test.magerun`):\n\n.. code-block:: sh\n\n   #!/usr/bin/env n98-magerun.phar script\n\n   config:set \"web/cookie/cookie_domain\" example.com\n   cache:flush\n\n   # Run a shell script with \"!\" as first char\n   ! ls -l\n\n   # Register your own variable (only key = value currently supported)\n   ${my.var}=bar\n\n   # Let magerun ask for variable value - add a question mark\n   ${my.var}=?\n\n   ! echo ${my.var}\n\n   # Use resolved variables from n98-magerun in shell commands\n   ! ls -l ${magento.root}/code/local\n\nPre-defined variables:\n\n* ${magento.root}    -\u003e Magento Root-Folder\n* ${magento.version} -\u003e Magento Version i.e. 1.7.0.2\n* ${magento.edition} -\u003e Magento Edition -\u003e Community or Enterprise\n* ${magerun.version} -\u003e Magerun version i.e. 1.66.0\n* ${php.version}     -\u003e PHP Version\n* ${script.file}     -\u003e Current script file path\n* ${script.dir}      -\u003e Current script file dir\n\nVariables can be passed to a script with \"--define (-d)\" option.\n\nExample:\n\n.. code-block:: sh\n\n   $ n98-magerun.phar script -d foo=bar filename\n\n   # This will register the variable ${foo} with value bar.\n\nIt's possible to define multiple values by passing more than one option.\n\n\nn98-magerun Script Repository\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\nYou can organize your scripts in a repository.\nSimply place a script in folder */usr/local/share/n98-magerun/scripts* or in your home dir\nin folder *\u003cHOME\u003e/.n98-magerun/scripts*.\n\nScripts must have the file extension *.magerun*.\n\nAfter that you can list all scripts with the *script:repo:list* command.\nThe first line of the script can contain a comment (line prefixed with #) which will be displayed as description.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar script:repo:list [--format[=\"...\"]]\n\nIf you want to execute a script from the repository this can be done by *script:repo:run* command.\n\n.. code-block:: sh\n\n   $ n98-magerun.phar script:repo:run [-d|--define[=\"...\"]] [--stop-on-error] [script]\n\nScript argument is optional. If you don't specify any you can select one from a list.\n\nAdvanced usage\n--------------\n\nAdd your own commands\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nhttps://github.com/netz98/n98-magerun/wiki/Add-custom-commands\n\nOverwrite default settings\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCreate the yaml config file **~/.n98-magerun.yaml**.\nNow you can define overwrites. The original config file is **config.yaml** in the source root folder.\n\nChange of i.e. default currency and admin users:\n\n.. code-block:: yaml\n\n    commands:\n      N98\\Magento\\Command\\Installer\\InstallCommand:\n        installation:\n          defaults:\n            currency: USD\n            admin_username: myadmin\n            admin_firstname: Firstname\n            admin_lastname: Lastname\n            admin_password: mydefaultSecret\n            admin_email: defaultemail@example.com\n\n\nAdd own Magento repositories\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nCreate the yaml config file **~/.n98-magerun.yaml**.\nNow you can define overwrites. The original config file is **config.yaml** in the source root folder.\n\nAdd your repo. The keys in the config file follow the composer package structure.\n\nExample::\n\n    commands:\n      N98\\Magento\\Command\\Installer\\InstallCommand:\n        magento-packages:\n          - name: my-magento-git-repository\n            version: 1.x.x.x\n            source:\n              url: git://myserver/myrepo.git\n              type: git\n              reference: 1.x.x.x\n            extra:\n              sample-data: sample-data-1.6.1.0\n\n          - name: my-zipped-magento\n            version: 1.7.0.0\n            dist:\n              url: http://www.myserver.example.com/magento-1.7.0.0.tar.gz\n              type: tar\n            extra:\n              sample-data: sample-data-1.6.1.0\n\nHow can you help?\n-----------------\n\n* Add new commands.\n* Send me some proposals if you miss anything.\n* Create issues if you find a bug or missing a feature.\n\nThanks to\n---------\n\n* Symfony2 Team for the great console component.\n* Composer Team for the downloader backend and the self-update command.\n* Francois Zaninotto for great Faker library.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetz98%2Fn98-magerun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetz98%2Fn98-magerun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetz98%2Fn98-magerun/lists"}