Merge pull request #13 from bcmi-labs/docs

Docs

Author: saniales

README.adoc

@@ -1,4 +1,5 @@
 = arduino-cli
+Alessandro Sanino <a[email protected]>
 
 Arduino CLI is a tool to access all Arduino Create API from Command Line.
 It implements all functions provided by web version of Arduino Create.
@@ -9,10 +10,10 @@ It implements all functions provided by web version of Arduino Create.
  . Reload shell configuration or reboot
  And you're done, now let's see how to use the CLI.
 
-== Usage 
+== Usage : An example
 
 A general call is `arduino [COMMAND] [options]`
-To see the full list of commands, call `arduino -h` or `arduino --help`
+To see the full list of commands, call `arduino help [COMMAND]`, arduino [COMMAND] -h` or `arduino [COMMAND] --help`
 
 == Contribution
 

cmd/root.go

@@ -39,8 +39,32 @@ import (
 )
 
 const (
-	// ArduinoVersion represents Arduino CLI version number.
-	ArduinoVersion string = "0.0.1-pre-alpha"
+  bashAutoCompletionFunction = `
+    __arduino_autocomplete() 
+    {
+        case $(last_command) in
+            arduino_lib)
+    		    opts="install uninstall list search version"
+    	        ;;
+    		arduino_lib_list)
+    		    opts="update"
+    			;;
+    		arduino_help)
+    		    opts="lib core version"
+    		    ;;
+            arduino)
+    		    opts="lib help version"
+    		    ;;
+	    esac		  
+    	if [[ ${cur} == " *" ]] ; then
+            COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+            return 0
+        fi
+	    return 1
+    }`,
+
+  // ArduinoVersion represents Arduino CLI version number.
+  ArduinoVersion string = "0.0.1-pre-alpha"	
 )
 
 // GlobalFlags represents flags available in all the program.
@@ -58,13 +82,14 @@ var RootCmd = &cobra.Command{
 	Use:   "arduino",
 	Short: "Arduino CLI",
 	Long:  "Arduino Create Command Line Interface (arduino-cli)",
+	BashCompletionFunction: bashAutoCompletionFunction,
 }
 
 // Execute adds all child commands to the root command sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
 func Execute() {
 	if err := RootCmd.Execute(); err != nil {
-		fmt.Println(err)
+		//fmt.Println(err)
 		os.Exit(1)
 	}
 }

docs/bash_completions/README.adoc

@@ -0,0 +1,31 @@
+= Bash Autocompletion 
+Alessandro Sanino <a[email protected]>
+
+File contained in this directory is the file to allow autocompletion of the arduino CLI commands
+
+== Installation
+. Move the file (using `sudo`) to directory `/etc/bash_completion.d`
+[source, bash]
+----
+sudo mv $PROJECT_DIR/docs/bash_completion/arduino /etc/bash_completion.d/
+----
+
+. Reload bash completion configuration :
+[source, bash]
+----
+source /etc/bash_completion
+. /etc/bash_completion.d/arduino
+----
+
+. Requires `$PROJECT_DIR` in `PATH` environment variable
+[source, bash]
+----
+export PATH=$PATH:$PROJECT_DIR
+----
+
+== How has been autocompletion obtained?
+It has been obtained by setting up the BashAutocompletionFunction field of Root Command
+
+```
+
+```