[GitHub] bpoole16 commented on a change in pull request #2520: Prints bashauto-completion install script to STDOUT

[gi...@git.apache.org]

bpoole16 commented on a change in pull request #2520: Prints bashauto-completion install script to STDOUT
URL: https://github.com/apache/incubator-openwhisk/pull/2520#discussion_r130690092
 
 

 ##########
 File path: docs/cli.md
 ##########
 @@ -38,6 +38,41 @@ you can run the following command from your `openwhisk` directory:
 
 To verify your CLI setup, try [creating and running an action](#openwhisk-hello-world-example).
 
+### Configure bashauto-completion for Openwhisk CLI
+
+For bashauto-completion to work, bash 4.1 or newer is required. The most recent Linux distributions should have the correct version of bash but Mac users will most likely have an older version.
+Mac users can check their bash version and update it by running the following commands:
+
+```
+bash --version
+brew install bash-completion
+```
+
+For most bash users, running the following command will be sufficient to install bashauto-completion:
+
+```
+eval "`wsk sdk install bashauto --bashrc`"
+```
+
+**Note:** `--bashrc` flag will attempt to locate your `.bashrc` and append the previous command, without `--bashrc`, to it.
+
+If this doesn't work, you can run a temporary installation using the following command:
+
+```
+eval "`wsk sdk install bashauto`"
 
 Review comment:
   This was the only way I could get eval to work correctly.
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services