airshipctl/docs/source/cli/airshipctl_config_init.md
Ruslan Aliev f7217245a7 Add --overwrite option to config init cmd
Currently airshipctl will overwrite an existing config file
by default during config init execution. This patch adds an
appropriate flag to explicitly control whether the user wants
to overwrite an existing file or not.

Change-Id: I9f4756b98e9d1245145809aed203974e99feb662
Signed-off-by: Ruslan Aliev <raliev@mirantis.com>
2020-11-14 00:52:37 +00:00

50 lines
1.2 KiB
Markdown

## airshipctl config init
Generate initial configuration file for airshipctl
### Synopsis
Generate an 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 file will be
written to 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
```
# Create new airshipctl config file at the default location
airshipctl config init
# Create new airshipctl config file at the custom location
airshipctl config init --airshipconf path/to/config
# Create new airshipctl config file at 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 file for airshipctl configuration. (default "$HOME/.airship/config")
--debug enable verbose output
```
### SEE ALSO
* [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file