-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update gocd CLI docs with more subcommand
- Loading branch information
1 parent
062d9b2
commit 45de867
Showing
3 changed files
with
95 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
## gocd-cli pipeline find | ||
|
||
Command to find all GoCD pipeline files present in a directory (it recursively finds for pipeline files in all sub-directory) | ||
|
||
``` | ||
gocd-cli pipeline find [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
gocd-cli pipeline find --path /path/to/pipelines --pattern *.gocd.yaml --pattern *.gocd.json | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-a, --absolute-path when enabled prints absolute path of the pipelines | ||
-h, --help help for find | ||
-f, --path string path to search for all GoCD pipeline files | ||
--pattern strings list of patterns to match while searching for all GoCD pipeline files (default [*.gocd.yaml,*.gocd.json,*.gocd.groovy]) | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) | ||
--ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one | ||
--from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. | ||
--json enable this to Render output in JSON format | ||
-l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") | ||
--no-color enable this to Render output in YAML format | ||
-p, --password string password to authenticate with GoCD server | ||
-q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath | ||
more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries | ||
--server-url string GoCD server URL base path (default "http://localhost:8153/go") | ||
--skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) | ||
--to-file string file to which the output needs to be written | ||
-u, --username string username to authenticate with GoCD server | ||
--yaml enable this to Render output in YAML format | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD | ||
|
||
###### Auto generated by spf13/cobra on 22-Nov-2023 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
## gocd-cli pipeline show | ||
|
||
Command to analyse pipelines part of a selected pipeline file | ||
|
||
``` | ||
gocd-cli pipeline show [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
gocd-cli show --pipeline /path/to/sample.gocd.yaml | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for show | ||
-f, --pipeline string path to GoCD pipeline config file to identify pipeline names | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-t, --auth-token string token to authenticate with GoCD server, should not be co-used with basic auth (username/password) | ||
--ca-file-path string path to file containing CA cert used to authenticate GoCD server, if you have one | ||
--from-file string file containing configurations of objects that needs to be created in GoCD, config-repo/pipeline-group/environment and etc. | ||
--json enable this to Render output in JSON format | ||
-l, --log-level string log level for gocd cli, log levels supported by [https://github.com/sirupsen/logrus] will work (default "info") | ||
--no-color enable this to Render output in YAML format | ||
-p, --password string password to authenticate with GoCD server | ||
-q, --query string query to filter the results, ex: '.material.attributes.type | id eq git'. this uses library gojsonq beneath | ||
more queries can be found here https://github.com/thedevsaddam/gojsonq/wiki/Queries | ||
--server-url string GoCD server URL base path (default "http://localhost:8153/go") | ||
--skip-cache-config if enabled locally save auth configs would not be used to authenticate GoCD server (path: $HOME/.gocd/auth_config.yaml) | ||
--to-file string file to which the output needs to be written | ||
-u, --username string username to authenticate with GoCD server | ||
--yaml enable this to Render output in YAML format | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [gocd-cli pipeline](gocd-cli_pipeline.md) - Command to operate on pipelines present in GoCD | ||
|
||
###### Auto generated by spf13/cobra on 22-Nov-2023 |