UffizziCloud / uffizzi_cli

The command-line interface for the Uffizzi API
Apache License 2.0
87 stars 46 forks source link

Add `install` as a subcommand option for `uffizzi -h` help page #383

Closed gadkins closed 10 months ago

gadkins commented 11 months ago

Update the uffizzi -h help page to include install as an option, as follows:

$ uffizzi -h
uffizzi - manage Uffizzi resources
================================================================

## SYNOPSIS
    uffizzi GROUP | COMMAND

## DESCRIPTION
    The uffizzi CLI manages authentication, configuration, and
    interaction with Uffizzi APIs.

    For more information on the uffizzi CLI, see:
    https://docs.uffizzi.com/references/cli/

## GROUP
    GROUP is one of the following:
     cluster
         Manage virtual clusters

     config
         Configure the uffizzi CLI

     connect
         Grant a Uffizzi user account access to external services

     compose
         Manage Uffizzi compose environments (previews) and view logs

     dev
         Creates a Uffizzi cluster preconfigured for development workflows

     install
         Install the Uffizzi platform data plane on a host cluster.

     project
         Manage Uffizzi project resources including compose files for
         specifying compose environment (preview) configurations and secrets

## COMMAND
    COMMAND is one of the following:

     help
         Show uffizzi documentation

     login
         Log in to a Uffizzi user account

     logout
         Log out of a Uffizzi user account

     version
         Print version information for uffizzi CLI