Skip to content

Commit

Permalink
Update CLI docs with newer flags added to configrepo definitions subc…
Browse files Browse the repository at this point in the history
…ommand
  • Loading branch information
nikhilsbhat committed May 19, 2024
1 parent e4a7e89 commit f89acb5
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/doc/gocd-cli_configrepo_get-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,21 @@ gocd-cli configrepo get-definitions [flags]
### Examples

```
gocd-cli configrepo get-definitions sample-repo -o yaml
gocd-cli configrepo get-definitions sample-repo -o yaml --pipelines #should print only pipeline names
gocd-cli configrepo get-definitions --repo-name sample-repo -o yaml
gocd-cli configrepo get-definitions --all -o yaml #should fetch definitions of all config repositories present in GoCD
gocd-cli configrepo get-definitions --repo-name sample-repo -o yaml --pipelines #should print only pipeline names
```

### Options

```
--environments set this flag to get only the environments from the config-repo
-h, --help help for get-definitions
--pipelines set this flag to get only the pipelines from the config-repo
--all when enabled gets config-repo definitions of all config repos present in GoCD
--detailed when enabled prints the information in detail
--environments set this flag to get only the environments from the config-repo
-h, --help help for get-definitions
--pipeline-group set this flag to get only the pipelines groups from the config-repo
--pipelines set this flag to get only the pipelines from the config-repo
--repo-name strings name of the configuration repository from which the definitions are to be retrieved
```

### Options inherited from parent commands
Expand All @@ -45,4 +50,4 @@ gocd-cli configrepo get-definitions sample-repo -o yaml --pipelines #should prin

* [gocd-cli configrepo](gocd-cli_configrepo.md) - Command to operate on configrepo present in GoCD [https://api.gocd.org/current/#config-repo]

###### Auto generated by spf13/cobra on 27-Jan-2024
###### Auto generated by spf13/cobra on 19-May-2024

0 comments on commit f89acb5

Please sign in to comment.