command-line interface for GoCD that helps in interacting with GoCD server.
While GoCD offers a user interface for performing various tasks, this CLI is designed for administrators responsible for managing GoCD. It aims to provide CLI-based functionality equivalent to the UI.
This tool communicates with the GoCD server's API to perform tasks such as encrypting and decrypting secrets, retrieving lists of pipelines, creating configuration repositories, and more.
This CLI utilizes the GoCD Golang SDK. If you encounter a bug with the CLI, it likely originates from the SDK.
- Go 1.17 or above . Installing go can be found here.
- Basic understanding of CI/CD server GoCD and GoCD golang sdk.
The authorization configuration for GoCD can be locally cached for future use, streamlining subsequent operations.
The command auth-config will do the work.
# Running the below command should cache configurations under $HOME/.gocd/auth_config.default.yaml.
# Here 'default' is the profile of GoCD. And profile would help in handling multiple GoCD server with same CLI.
# If no profile is set, it defaults to 'default'. The profile can be set using flag '--profile'.
gocd-cli auth-config store --server-url <gocd-url> --username <username> --password <password>
# Running below command by setting --profile would save cache under $HOME/.gocd/auth_config.central.yaml.
gocd-cli auth-config store --server-url <gocd-url> --username <username> --password <password> --profile central
# User creds cached can be validated using below command.
gocd-cli who-am-i
# The response to the above command should be:
# user: admin
# Once we have authorization configurations cached, we do not need to pass the credentials every time we invoke the cli.
gocd-cli environment listThe gocd-cli will display any pending updates in a diff format, similar to how it is commonly done in other CLI tools such as Terraform.
Updated documentation on all available commands and flags can be found here.
- Recommend installing released versions. Release binaries are available on the releases page.
Install gocd-cli on macOS
brew tap nikshilsbhat/stable [email protected]:nikhilsbhat/homebrew-stable.git
# for latest version
brew install nikshilsbhat/stable/gocd-cli
# for specific version
brew install nikshilsbhat/stable/[email protected]Check repo for all available versions of the formula.
Latest version of docker images are published to ghcr.io, all available images can be found there.
docker pull ghcr.io/nikhilsbhat/gocd-cli:latest
docker pull ghcr.io/nikhilsbhat/gocd-cli:<github-release-tag>- Clone the repository:
git clone https://github.com/nikhilsbhat/gocd-cli.git cd gocd-cli - Build the project:
make local.build
- The
gocd-cli pipeline validate-syntaxcommand uses the GoCD plugin binary to validate the pipeline's syntax. - Since the plugins are in JAR format, Java must be installed on the machine where the command will be executed.