From dd40bd755625855f8c0703a1b8809ef95378f1bb Mon Sep 17 00:00:00 2001 From: Yaroslav Voronoy Date: Sat, 11 Jun 2016 01:48:31 +0300 Subject: [PATCH 1/3] Update README.md --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d75d50..c555ea9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ -# magento2-bash-completion -Magento2 Bash Completion +# Magento2 Bash Completion +One of the nicest facilities of the modern shell is the built in bash completion support. This script allows you to complete commands and options for Magento CLI bin/magento. + +## Example +``` +user@host:~$ bin/magento[TAB][TAB] +admin:user:create info:dependencies:show-modules-circular +admin:user:unlock info:language:list +bash:completion:generate info:timezone:list +cache:clean list +cache:disable maintenance:allow-ips +cache:enable maintenance:disable +... +``` + +``` +user@host:~$ bin/magento setup:install --[TAB][TAB] +--admin-email --db-password +--admin-firstname --db-prefix +--admin-lastname --db-user +--admin-password --definition-format +--admin-use-security-key --http-cache-hosts +--admin-user --key +--backend-frontname --language +--base-url --magento-init-params +--base-url-secure --sales-order-increment-prefix +--cleanup-database --session-save +--currency --skip-db-validation +--db-engine --timezone +--db-host --use-rewrites +--db-init-statements --use-sample-data +--db-model --use-secure +--db-name --use-secure-admin +``` + +## Installation +New completion commands may be placed inside the directory /etc/bash_completion.d or inside /usr/local/etc/bash_completion.d/magento2-bash-completion on MacOSX. + +Mac OSX +``` +sudo curl -o /usr/local/etc/bash_completion.d/magento2-bash-completion https://raw.githubusercontent.com/yvoronoy/magento2-bash-completion/master/magento2-bash-completion +``` + + +Linux +``` +#Linux +sudo curl -o /etc/bash_completion.d/magento2-bash-completion https://raw.githubusercontent.com/yvoronoy/magento2-bash-completion/master/magento2-bash-completion +``` + +Don't forget reload shell or you can load new complition by next command: `user@host:~$ . /etc/bash_completion.d/magento2-bash-completion` + + +If you don't have installed bash-completion follow these guides: + * (How to install bash-completion in Debian)[https://www.howtoforge.com/how-to-add-bash-completion-in-debian] + * (How to install bash-completion in MacOSX)[http://davidalger.com/development/bash-completion-on-os-x-with-MacOSX From 4e9dd38dbd4a4aa2b6d222a430d8a735b604a201 Mon Sep 17 00:00:00 2001 From: Yaroslav Voronoy Date: Sat, 11 Jun 2016 02:32:41 +0300 Subject: [PATCH 2/3] Update README.md --- README.md | 20 ++++---------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c555ea9..64ef5fc 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,15 @@ One of the nicest facilities of the modern shell is the built in bash completion support. This script allows you to complete commands and options for Magento CLI bin/magento. ## Example + +![Magento2 Bash Completion Screenshot](https://raw.githubusercontent.com/yvoronoy/ReadmeMedia/master/magento2-bash-completion.gif) + ``` user@host:~$ bin/magento[TAB][TAB] admin:user:create info:dependencies:show-modules-circular admin:user:unlock info:language:list bash:completion:generate info:timezone:list -cache:clean list -cache:disable maintenance:allow-ips -cache:enable maintenance:disable + ... ``` @@ -18,19 +19,6 @@ user@host:~$ bin/magento setup:install --[TAB][TAB] --admin-email --db-password --admin-firstname --db-prefix --admin-lastname --db-user ---admin-password --definition-format ---admin-use-security-key --http-cache-hosts ---admin-user --key ---backend-frontname --language ---base-url --magento-init-params ---base-url-secure --sales-order-increment-prefix ---cleanup-database --session-save ---currency --skip-db-validation ---db-engine --timezone ---db-host --use-rewrites ---db-init-statements --use-sample-data ---db-model --use-secure ---db-name --use-secure-admin ``` ## Installation From 765be30c1fd68afcb142ef5c74297424979bea97 Mon Sep 17 00:00:00 2001 From: Yaroslav Voronoy Date: Sat, 11 Jun 2016 02:40:02 +0300 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 64ef5fc..e8aa33b 100644 --- a/README.md +++ b/README.md @@ -40,5 +40,5 @@ Don't forget reload shell or you can load new complition by next command: `user@ If you don't have installed bash-completion follow these guides: - * (How to install bash-completion in Debian)[https://www.howtoforge.com/how-to-add-bash-completion-in-debian] - * (How to install bash-completion in MacOSX)[http://davidalger.com/development/bash-completion-on-os-x-with-MacOSX + * [How to install bash-completion in Debian](https://www.howtoforge.com/how-to-add-bash-completion-in-debian) + * [How to install bash-completion in MacOSX](http://davidalger.com/development/bash-completion-on-os-x-with-MacOSX)