diff --git a/HISTORY.rst b/HISTORY.rst index b757ec66..997e6059 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -10,6 +10,7 @@ PlatformIO 2.0 * Full support of `CLion IDE `_ including code auto-completion (`issue #132 `_) +* PlatformIO `command completion in Terminal `_ for ``bash`` and ``zsh`` * Added support for ubIQio Ardhat board (`pull #302 `_) * Use Teensy CLI Loader for upload of .hex files on Mac OS X diff --git a/docs/faq.rst b/docs/faq.rst index 8a7fc30d..bdbec42a 100644 --- a/docs/faq.rst +++ b/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: