diff options
| author | Nicholas Meriano <nicmeriano@gmail.com> | 2019-10-03 04:51:17 -0700 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2019-10-03 13:51:17 +0200 |
| commit | ff23aa0bf9851c477b956c89882fdd04e143042e (patch) | |
| tree | da300c0861af1e86bb2ca1c5d9c99a08094d4582 /plugins/n98-magerun | |
| parent | ae0de1135dc96cfabe31d70f65112cbeadbfa3bf (diff) | |
| download | zsh-ff23aa0bf9851c477b956c89882fdd04e143042e.tar.gz zsh-ff23aa0bf9851c477b956c89882fdd04e143042e.tar.bz2 zsh-ff23aa0bf9851c477b956c89882fdd04e143042e.zip | |
n98-magerun: add README (#8200)
Diffstat (limited to 'plugins/n98-magerun')
| -rw-r--r-- | plugins/n98-magerun/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/plugins/n98-magerun/README.md b/plugins/n98-magerun/README.md new file mode 100644 index 000000000..b0abe4747 --- /dev/null +++ b/plugins/n98-magerun/README.md @@ -0,0 +1,21 @@ +# n98-magerun plugin + +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. + +The [n98-magerun plugin](https://github.com/netz98/n98-magerun) provides many +[useful aliases](#aliases) as well as completion for the `n98-magerun` command. + +Enable it by adding `n98-magerun` to the plugins array in your zshrc file: + +```zsh +plugins=(... n98-magerun) +``` + +## Aliases + +| Alias | Command | Description | +| --------- | -------------------------------------------------- | --------------------------------------------------------------------------------- | +| n98 | `n98-magerun.phar` | The N98-Magerun phar-file (Version 1) | +| n98-2 | `n98-magerun2.phar` | The N98-Magerun phar-file (Version 2) | +| mage-get | `wget https://files.magerun.net/n98-magerun.phar` | Download the latest stable N98-Magerun phar-file from the file-server (Version 1) | +| mage2-get | `wget https://files.magerun.net/n98-magerun2.phar` | Download the latest stable N98-Magerun phar-file from the file-server (Version 2) | |