PlatformIO command completion in Terminal for bash and zsh // Resolve #290

HISTORY.rst

@@ -10,6 +10,7 @@ PlatformIO 2.0
 * Full support of `CLion IDE <http://docs.platformio.org/en/latest/ide/clion.html>`_
   including code auto-completion
   (`issue #132 <https://github.com/platformio/platformio/issues/132>`_)
+* PlatformIO `command completion in Terminal <http://docs.platformio.org/en/latest/faq.html#command-completion-in-terminal>`_ for ``bash`` and ``zsh``
 * Added support for ubIQio Ardhat board
   (`pull #302 <https://github.com/platformio/platformio/pull/302>`_)
 * Use Teensy CLI Loader for upload of .hex files on Mac OS X

docs/faq.rst

@@ -56,8 +56,8 @@ the project developed using PlatformIO is as follows:
 * Users develop code and PlatformIO makes sure that it is compiled, prepared
   and uploaded to all the boards of interest.
 
-Commands completion in Terminal
+Command completion in Terminal
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Bash completion
 '''''''''''''''
@@ -69,6 +69,21 @@ Bash completion for `platformio` subcommands you need to put into your `.bashrc`
 
     eval "$(_PLATFORMIO_COMPLETE=source platformio)"
 
+ZSH completion
+''''''''''''''
+
+To enable ``zsh`` completion please run these commands:
+
+.. code-block: bash
+
+    autoload bashcompinit && bashcompinit
+    eval "$(_PLATFORMIO_COMPLETE=source platformio)"
+
+.. note::
+
+    For permanent command completion you need to place commands above to
+    ``~/.bashrc`` or ``~/.zshrc`` file.
+
 .. _faq_troubleshooting:
 
 Troubleshooting
@@ -89,6 +104,9 @@ Try these solutions:
     [sudo] pip uninstall scons
     [sudo] pip install scons
 
+    # if you have "error: option --single-version-externally-managed not recognized", then
+    [sudo] pip install --egg scons
+
 2. Install PlatformIO using :ref:`installation_installer_script`.
 
 .. _faq_troubleshooting_sconssingverextmanaged: