Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Viktor Gal committed Jan 24, 2022
1 parent 0a511f7 commit 2a1df2b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/how-to-guides/shell-integration.rst
Expand Up @@ -5,6 +5,14 @@ Shell integration of Renku CLI

Renku CLI supports shell auto-completion for Renku commands and their arguments like datasets and workflows.

A convenience method is available for printing to the standard output the shell completion command for the
currently used shell:

.. code-block:: console
$ renku env --shell-completion
_RENKU_COMPLETE=zsh_source renku
To activate tab completion for your supported shell run the following command after installing Renku CLI:

.. tabs::
Expand Down Expand Up @@ -37,7 +45,7 @@ in case of ``renku workflow execute`` the available ``Plans`` are going to be li
.. note::

Tab completion of available ``Plans`` only works if the user is executing the command
Tab completion of available ``Plans`` (or ``Datasets``) only works if the user is executing the command
within a Renku project.


Expand Down

0 comments on commit 2a1df2b

Please sign in to comment.