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

47 lines
1.1 KiB
Markdown

## airshipctl document pull
Airshipctl command to pull manifests from remote git repositories
### Synopsis
The remote manifests repositories as well as the target path where
the repositories will be cloned are defined in the airship config file.
By default the airship config file is initialized with the
repository "https://opendev.org/airship/treasuremap" as a source of
manifests and with the manifests target path "$HOME/.airship/default".
```
airshipctl document pull [flags]
```
### Examples
```
Pull manifests from remote repos
# airshipctl document pull
>>>>>>> Updating cmd files for documentation
```
### Options
```
-h, --help help for pull
-n, --no-checkout no checkout is performed after the clone is complete.
```
### Options inherited from parent commands
```
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
--debug enable verbose output
```
### SEE ALSO
* [airshipctl document](airshipctl_document.md) - Airshipctl command to manage site manifest documents