From ede85ccc86bb2a40069140cc1ed6b09a94be95b7 Mon Sep 17 00:00:00 2001 From: Romil Bhardwaj Date: Thu, 16 May 2024 10:07:01 -0700 Subject: [PATCH] docs --- docs/source/getting-started/installation.rst | 4 ++++ sky/cli.py | 12 +++++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/source/getting-started/installation.rst b/docs/source/getting-started/installation.rst index 490d2d76311..42336bcd5cc 100644 --- a/docs/source/getting-started/installation.rst +++ b/docs/source/getting-started/installation.rst @@ -164,6 +164,10 @@ section :ref:`below `. If your clouds show ``enabled`` --- |:tada:| |:tada:| **Congratulations!** |:tada:| |:tada:| You can now head over to :ref:`Quickstart ` to get started with SkyPilot. +.. tip:: + + To check credentials only for specific clouds, pass the clouds as arguments: :code:`sky check aws gcp` + .. _cloud-account-setup: Cloud account setup diff --git a/sky/cli.py b/sky/cli.py index 5abd12f4caa..365468f0bba 100644 --- a/sky/cli.py +++ b/sky/cli.py @@ -2862,7 +2862,7 @@ def _down_or_stop(name: str): progress.refresh() -@cli.command() +@cli.command(cls=_DocumentedCodeCommand) @click.argument('clouds', required=False, type=str, nargs=-1) @click.option('--verbose', '-v', @@ -2881,6 +2881,16 @@ def check(clouds: Tuple[str], verbose: bool): The enabled clouds are cached and form the "search space" to be considered for each task. + + Examples: + + .. code-block:: bash + + # Check credentials for all supported clouds. + sky check + \b + # Check only specific clouds - AWS and GCP. + sky check aws gcp """ clouds_arg = clouds if len(clouds) > 0 else None sky_check.check(verbose=verbose, clouds=clouds_arg)