Sirisha Gopigiri 4da8a54887 Separate folders-Create airshipctl cli user guide documentation

Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org

Steps to render the document locally

	* Install sphinx: python3 -m pip install sphinx
        * Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
        * Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
	* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
	* Run local server: cd _build; python3 -m http.server
	* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document

Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352

2021-06-28 10:20:55 +05:30

1.4 KiB

Raw Permalink Blame History

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

1.4 KiB Raw Permalink Blame History