diff --git a/docs/installation.rst b/docs/installation.rst index 4bb78a1193..00bb2781e0 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -21,6 +21,27 @@ Installation 3. Done! Now you can :ref:`create your first test ` +Optional: CLI tab completion +---------------------------- + +Locust uses the argcomplete_ module to provide tab completions for the ``locust`` command line interface. +This is entirely optional; if you don't care about tab completion, you can skip this section entirely! +If you do want to enable tab completion, first install the ``argcomplete`` module +into the same environment where you installed ``locust``: + +.. code-block:: console + + $ pip3 install argcomplete + +Then add this line to your shell config file +(``~/.bashrc`` if you use ``bash``, ``~/.zshrc`` if you use ``zsh``): + +.. code-block:: console + + eval "$(register-python-argcomplete locust)" + +Restart your shell, and you should have working tab completion for the ``locust`` CLI! +If this doesn't work, `check the argcomplete documentation `_. Pre-release builds ------------------ @@ -37,3 +58,5 @@ Install for development ----------------------- If you want to modify Locust, or contribute to the project, see :ref:`developing-locust`. + +.. _argcomplete: https://github.com/kislyuk/argcomplete \ No newline at end of file