airshipctl/docs/source/cli/airshipctl.md
Sirisha Gopigiri 21f015b502 Updating cmd files for documentation
This PS updates cmd related to root, completion, document and
version subcommands. It also updates minor details in other
subcommands.

The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I562c15c0d25b2e9731c0eb03854d1d348eb435f2
2021-06-09 09:56:21 +00:00

32 lines
1.4 KiB
Markdown

## airshipctl
A unified command line tool for management of end-to-end kubernetes cluster deployment on cloud infrastructure environments.
### Synopsis
Command line utility for management of end-to-end kubernetes cluster deployment.
Find more information at: https://docs.airshipit.org/airshipctl/
### Options
```
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
--debug enable verbose output
-h, --help help for airshipctl
```
### SEE ALSO
* [airshipctl baremetal](airshipctl_baremetal.md) - Airshipctl command to manage bare metal host(s)
* [airshipctl cluster](airshipctl_cluster.md) - Airshipctl command to manage kubernetes clusters
* [airshipctl completion](airshipctl_completion.md) - Airshipctl command to generate completion script for the specified shell (bash or zsh)
* [airshipctl config](airshipctl_config.md) - Airshipctl command to manage airshipctl config file
* [airshipctl document](airshipctl_document.md) - Airshipctl command to manage site manifest documents
* [airshipctl phase](airshipctl_phase.md) - Airshipctl command to manage phases
* [airshipctl plan](airshipctl_plan.md) - Airshipctl command to manage plans
* [airshipctl secret](airshipctl_secret.md) - Airshipctl command to manage secrets
* [airshipctl version](airshipctl_version.md) - Airshipctl command to display the current version number