From 2a1df2b40591631e575e9089de055c56ac88a556 Mon Sep 17 00:00:00 2001 From: Viktor Gal Date: Mon, 24 Jan 2022 09:18:14 +0100 Subject: [PATCH] update documentation --- docs/how-to-guides/shell-integration.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/how-to-guides/shell-integration.rst b/docs/how-to-guides/shell-integration.rst index f4707a1700..03c58547a2 100644 --- a/docs/how-to-guides/shell-integration.rst +++ b/docs/how-to-guides/shell-integration.rst @@ -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:: @@ -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.