Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: explain how to use boolean or list values #186

Merged
merged 2 commits into from
May 6, 2024
Merged

docs: explain how to use boolean or list values #186

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
334c686
docs: explain how to use boolean or list values
ArzelaAscoIi May 5, 2024
a235acc
Update deepset_cloud_sdk/cli.py
ArzelaAscoIi May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion deepset_cloud_sdk/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
ArzelaAscoIi marked this conversation as resolved.
Show resolved Hide resolved
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 <command> --help` to see the arguments for a specific command.

Boolean values are converted to `-no-<variable>` or `-<variable>` 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:
Expand Down
Loading