airshipctl/cmd/config/testdata/TestConfigInitGoldenOutput/config-init-help.golden
Sirisha Gopigiri 3274b41151 Config- updating cmd files for documentation
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: If3ec175e2f582919296576a4bff6ae64871a7333
2021-05-25 12:14:59 +05:30

24 lines
873 B
Plaintext

Generates airshipctl config file. This file by default will be written to the $HOME/.airship directory,
and will contain default configuration. In case if flag --airshipconf provided - the default configuration
will be written to the file in the specified location instead. If a configuration file already exists
at the specified path, an error will be thrown; to overwrite it, specify the --overwrite flag.
Usage:
init [flags]
Examples:
To create new airshipctl config file at the default location
# airshipctl config init
To create new airshipctl config file at the custom location
# airshipctl config init --airshipconf path/to/config
To create new airshipctl config file at the custom location and overwrite it
# airshipctl config init --overwrite --airshipconf path/to/config
Flags:
-h, --help help for init
--overwrite overwrite config file