summaryrefslogtreecommitdiff
path: root/plugins/n98-magerun
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-10-09 20:16:18 -0600
committerTuowen Zhao <ztuowen@gmail.com>2019-10-09 20:16:18 -0600
commit112a85697481cae663ff281b74fdc1f72a67b294 (patch)
treee7f6f938fda886c87d296711d853bcc9833b9ec2 /plugins/n98-magerun
parent09829ba30c269e35bddf44a21f3357efd31e686f (diff)
parent710a3d5a1e2888a4dfb1769f8f1edd8a590eee22 (diff)
downloadzsh-112a85697481cae663ff281b74fdc1f72a67b294.tar.gz
zsh-112a85697481cae663ff281b74fdc1f72a67b294.tar.bz2
zsh-112a85697481cae663ff281b74fdc1f72a67b294.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/n98-magerun')
-rw-r--r--plugins/n98-magerun/README.md21
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) |