Skip to content

Commit

Permalink
Update gocd CLI docs with more subcommand
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhilsbhat committed Nov 22, 2023
1 parent 062d9b2 commit 45de867
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/doc/gocd-cli_pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ gocd-cli pipeline [flags]
* [gocd-cli pipeline create](gocd-cli_pipeline_create.md) - Command to CREATE the pipeline with all specified configuration [https://api.gocd.org/current/#create-a-pipeline]
* [gocd-cli pipeline delete](gocd-cli_pipeline_delete.md) - Command to DELETE the specified pipeline from GoCD [https://api.gocd.org/current/#delete-a-pipeline]
* [gocd-cli pipeline export-format](gocd-cli_pipeline_export-format.md) - Command to export specified pipeline present in GoCD to appropriate config repo format [https://api.gocd.org/current/#export-pipeline-config-to-config-repo-format]
* [gocd-cli pipeline find](gocd-cli_pipeline_find.md) - Command to find all GoCD pipeline files present in a directory (it recursively finds for pipeline files in all sub-directory)
* [gocd-cli pipeline get](gocd-cli_pipeline_get.md) - Command to GET pipeline config of a specified pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-config]
* [gocd-cli pipeline get-all](gocd-cli_pipeline_get-all.md) - Command to GET all pipelines present in GoCD [https://api.gocd.org/current/#get-feed-of-all-stages-in-a-pipeline]
* [gocd-cli pipeline get-mappings](gocd-cli_pipeline_get-mappings.md) - Command to Identify the given pipeline is part of which config-repo/environment of GoCD
Expand All @@ -55,10 +56,11 @@ gocd-cli pipeline [flags]
* [gocd-cli pipeline list](gocd-cli_pipeline_list.md) - Command to LIST all the pipelines present in GoCD [https://api.gocd.org/current/#get-feed-of-all-stages-in-a-pipeline]
* [gocd-cli pipeline not-scheduled](gocd-cli_pipeline_not-scheduled.md) - Command to GET pipelines not scheduled in last X days from GoCD [/pipelineHistory.json?]
* [gocd-cli pipeline schedule](gocd-cli_pipeline_schedule.md) - Command to SCHEDULE a specific pipeline present in GoCD [https://api.gocd.org/current/#scheduling-pipelines]
* [gocd-cli pipeline show](gocd-cli_pipeline_show.md) - Command to analyse pipelines part of a selected pipeline file
* [gocd-cli pipeline status](gocd-cli_pipeline_status.md) - Command to GET status of a specific pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-status]
* [gocd-cli pipeline template](gocd-cli_pipeline_template.md) - Command to EXTRACT template from specific pipeline instance present in GoCD [https://api.gocd.org/current/#extract-template-from-pipeline]
* [gocd-cli pipeline update](gocd-cli_pipeline_update.md) - Command to UPDATE the pipeline config with the latest specified configuration [https://api.gocd.org/current/#edit-pipeline-config]
* [gocd-cli pipeline validate-syntax](gocd-cli_pipeline_validate-syntax.md) - Command validate pipeline syntax by running it against appropriate GoCD plugin
* [gocd-cli pipeline vsm](gocd-cli_pipeline_vsm.md) - Command to GET downstream pipelines of a specified pipeline present in GoCD [https://api.gocd.org/current/#get-pipeline-config]

###### Auto generated by spf13/cobra on 16-Sep-2023
###### Auto generated by spf13/cobra on 22-Nov-2023
47 changes: 47 additions & 0 deletions docs/doc/gocd-cli_pipeline_find.md
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
45 changes: 45 additions & 0 deletions docs/doc/gocd-cli_pipeline_show.md
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

0 comments on commit 45de867

Please sign in to comment.