From 334c6865f2d341d5cc44ec44cff45ef6cd918a29 Mon Sep 17 00:00:00 2001 From: Kristof Herrmann Date: Sun, 5 May 2024 17:31:38 +0200 Subject: [PATCH 1/2] docs: explain how to use boolean or list values --- deepset_cloud_sdk/cli.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/deepset_cloud_sdk/cli.py b/deepset_cloud_sdk/cli.py index 40022b86..a8e3f19a 100644 --- a/deepset_cloud_sdk/cli.py +++ b/deepset_cloud_sdk/cli.py @@ -316,7 +316,19 @@ def main( None, "--version", callback=version_callback, is_eager=True, help="Show the SDK version and exit." ) ) -> None: # noqa - """The CLI for the deepset Cloud SDK.""" + """The CLI for the deepset Cloud SDK. + + This documentation uses pythons type hints to provide information about the arguments and return values. + Typer turns these type hints into a CLI interface. To see how these arguments are used in the CLI, check the + Typer documentation: https://typer.tiangolo.com/tutorial/arguments/optional or run + `deepset-cloud --help` to see the arguments for a specific command. + + Boolean values are converted to `-no-` or `-` flags in the CLI. For example, to disable + the progress bar, use `--no-show-progress`. + + Lists can be passed by using the same flag multiple times. For example, to scan only `.txt` and `.pdf` files, + when uploading use `--use-type .txt --use-type .pdf`. + """ def run_packaged() -> None: From a235acc3d74d4f380b2a61cabcf7c235aa5d75a5 Mon Sep 17 00:00:00 2001 From: ArzelaAscoIi <37148029+ArzelaAscoIi@users.noreply.github.com> Date: Mon, 6 May 2024 09:28:41 +0200 Subject: [PATCH 2/2] Update deepset_cloud_sdk/cli.py Co-authored-by: Agnieszka Marzec <97166305+agnieszka-m@users.noreply.github.com> --- deepset_cloud_sdk/cli.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deepset_cloud_sdk/cli.py b/deepset_cloud_sdk/cli.py index a8e3f19a..c7824687 100644 --- a/deepset_cloud_sdk/cli.py +++ b/deepset_cloud_sdk/cli.py @@ -318,7 +318,7 @@ def main( ) -> None: # noqa """The CLI for the deepset Cloud SDK. - This documentation uses pythons type hints to provide information about the arguments and return values. + This documentation uses Python type hints to provide information about the arguments and return values. Typer turns these type hints into a CLI interface. To see how these arguments are used in the CLI, check the Typer documentation: https://typer.tiangolo.com/tutorial/arguments/optional or run `deepset-cloud --help` to see the arguments for a specific command.