Skip to content

Commit

Permalink
[docs] Docs for sky check specific cloud (#3558)
Browse files Browse the repository at this point in the history
docs
  • Loading branch information
romilbhardwaj authored May 16, 2024
1 parent 1285e03 commit 4a66806
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/source/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ section :ref:`below <cloud-account-setup>`.
If your clouds show ``enabled`` --- |:tada:| |:tada:| **Congratulations!** |:tada:| |:tada:| You can now head over to
:ref:`Quickstart <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
Expand Down
12 changes: 11 additions & 1 deletion sky/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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)
Expand Down

0 comments on commit 4a66806

Please sign in to comment.