-
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/Create cli documentation for newer commands
- Loading branch information
1 parent
1e01018
commit f4b9969
Showing
109 changed files
with
664 additions
and
187 deletions.
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
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
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
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
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
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,53 @@ | ||
| ## gocd-cli artifact | ||
|
|
||
| Command to operate on artifacts store/config present in GoCD | ||
|
|
||
| ### Synopsis | ||
|
|
||
| Command leverages GoCD agents apis' [https://api.gocd.org/current/#artifacts-config, https://api.gocd.org/current/#artifact-store] to | ||
| GET/CREATE/UPDATE/DELETE GoCD artifact | ||
|
|
||
| ``` | ||
| gocd-cli artifact [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for artifact | ||
| ``` | ||
|
|
||
| ### 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 to (this works only if --yaml or --json is enabled) | ||
| -u, --username string username to authenticate with GoCD server | ||
| --yaml enable this to Render output in YAML format | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [gocd-cli](gocd-cli.md) - Command line interface for GoCD | ||
| * [gocd-cli artifact create-store](gocd-cli_artifact_create-store.md) - Command to CREATE an artifact store with all specified configurations in GoCD [https://api.gocd.org/current/#create-an-artifact-store] | ||
| * [gocd-cli artifact delete-store](gocd-cli_artifact_delete-store.md) - Command to DELETE a specific artifact store present in GoCD [https://api.gocd.org/current/#delete-an-artifact-store] | ||
| * [gocd-cli artifact get-all-stores](gocd-cli_artifact_get-all-stores.md) - Command to GET all the artifact stores present in GoCD [https://api.gocd.org/current/#get-all-artifact-stores] | ||
| * [gocd-cli artifact get-config](gocd-cli_artifact_get-config.md) - Command to GET a configured artifact configuration GoCD [https://api.gocd.org/current/#get-artifacts-config] | ||
| * [gocd-cli artifact get-store](gocd-cli_artifact_get-store.md) - Command to GET an specific artifact store in GoCD [https://api.gocd.org/current/#get-an-artifact-store] | ||
| * [gocd-cli artifact job-history](gocd-cli_artifact_job-history.md) - Command to GET information of the jobs that ran on a specific agent present in GoCD [https://api.gocd.org/current/#agent-job-run-history] | ||
| * [gocd-cli artifact kill-task](gocd-cli_artifact_kill-task.md) - Command to KILL a specific task running on a specific agent present in GoCD [https://api.gocd.org/current/#kill-running-tasks] | ||
| * [gocd-cli artifact list-store](gocd-cli_artifact_list-store.md) - Command to LIST all artifact stores present in GoCD [https://api.gocd.org/current/#get-all-artifact-stores] | ||
| * [gocd-cli artifact update-config](gocd-cli_artifact_update-config.md) - Command to UPDATE artifact config specified configurations in GoCD [https://api.gocd.org/current/#update-artifacts-config] | ||
| * [gocd-cli artifact update-store](gocd-cli_artifact_update-store.md) - Command to UPDATE an artifact store with all specified configurations in GoCD [https://api.gocd.org/current/#update-an-artifact-store] | ||
|
|
||
| ###### Auto generated by spf13/cobra on 13-Jun-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,38 @@ | ||
| ## gocd-cli artifact create-store | ||
|
|
||
| Command to CREATE an artifact store with all specified configurations in GoCD [https://api.gocd.org/current/#create-an-artifact-store] | ||
|
|
||
| ``` | ||
| gocd-cli artifact create-store [flags] | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| ``` | ||
| -h, --help help for create-store | ||
| ``` | ||
|
|
||
| ### 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 to (this works only if --yaml or --json is enabled) | ||
| -u, --username string username to authenticate with GoCD server | ||
| --yaml enable this to Render output in YAML format | ||
| ``` | ||
|
|
||
| ### SEE ALSO | ||
|
|
||
| * [gocd-cli artifact](gocd-cli_artifact.md) - Command to operate on artifacts store/config present in GoCD | ||
|
|
||
| ###### Auto generated by spf13/cobra on 13-Jun-2023 |
Oops, something went wrong.