airshipctl/docs/source/cli/airshipctl_config_init.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

1.3 KiB

airshipctl config init

Airshipctl command to generate initial configuration file for airshipctl

Synopsis

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.

airshipctl config 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

Options

  -h, --help        help for init
      --overwrite   overwrite config file

Options inherited from parent commands

      --airshipconf string   path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
      --debug                enable verbose output

SEE ALSO