Skip to content

Commit

Permalink
Update readme with more information
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhilsbhat committed Apr 3, 2024
1 parent 1fe7ba6 commit 2fc151d
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 11 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ command-line interface for `GoCD` that helps in interacting with [GoCD](https://

## Introduction

GoCD has user interface from where all the work that this CLI does can be operated, but this cli targets admins who manage GoCD.
By providing cli equivalent support of the UI.
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 interacts with `GoCD` server's api to encrypt, decrypt secrets get list of pipelines, create config-repos and many more.
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 uses GoCD golang [sdk](https://github.com/nikhilsbhat/gocd-sdk-go). If you find bug with CLI, probably that bug would at the SDK.
This CLI utilizes the GoCD Golang [SDK](https://github.com/nikhilsbhat/gocd-sdk-go). If you encounter a bug with the CLI, it likely originates from the SDK.

## Requirements

Expand All @@ -24,7 +24,7 @@ This cli uses GoCD golang [sdk](https://github.com/nikhilsbhat/gocd-sdk-go). If

## Authorization

The authorization configuration used for GoCD can be cached locally so that it can be used for future operations.
The authorization configuration for GoCD can be locally cached for future use, streamlining subsequent operations.

The command `auth-config` will do the work.

Expand All @@ -41,6 +41,12 @@ gocd-cli who-am-i
gocd-cli environment list
```

## Update

The `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.

![update](assets/gocd-cli-update-feature.gif)

## Documentation

Updated documentation on all available commands and flags can be found [here](https://github.com/nikhilsbhat/gocd-cli/blob/main/docs/doc/gocd-cli.md).
Expand All @@ -61,5 +67,5 @@ docker pull ghcr.io/nikhilsbhat/gocd-cli:<github-release-tag>

### Note

* The command `gocd-cli pipeline validate-syntax` would use GoCD's plugin binary to validate the pipeline syntax.
* Since the plugins are jars, it is expected to have Java installed, on the machine from which the command would be executed.
* The `gocd-cli pipeline validate-syntax` command utilizes GoCD's plugin binary to validate the syntax of the pipeline.
* As the plugins are in JAR format, Java installation is required on the machine where the command will be executed.
Binary file added assets/gocd-cli-update-feature.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ module github.com/nikhilsbhat/gocd-cli
go 1.21.1

require (
github.com/fatih/color v1.16.0
github.com/ghodss/yaml v1.0.0
github.com/goccy/go-yaml v1.11.3
github.com/nikhilsbhat/common v0.0.5
github.com/nikhilsbhat/gocd-sdk-go v0.1.9
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2
github.com/sirupsen/logrus v1.9.3
github.com/spf13/cobra v1.7.0
github.com/stretchr/testify v1.9.0
Expand All @@ -21,6 +19,7 @@ require (
require (
github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/fatih/color v1.16.0 // indirect
github.com/go-resty/resty/v2 v2.11.0 // indirect
github.com/gocarina/gocsv v0.0.0-20231116093920-b87c2d0e983a // indirect
github.com/google/go-cmp v0.6.0 // indirect
Expand All @@ -32,6 +31,7 @@ require (
github.com/mattn/go-runewidth v0.0.9 // indirect
github.com/neilotoole/jsoncolor v0.7.1 // indirect
github.com/olekukonko/tablewriter v0.0.5 // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/tidwall/match v1.1.1 // indirect
Expand Down
2 changes: 0 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/Qd
github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
github.com/neilotoole/jsoncolor v0.7.1 h1:/MoU7KPLcto+ykcy592Y8eX9WFQhoi3IBEbwrP89dgs=
github.com/neilotoole/jsoncolor v0.7.1/go.mod h1:KZ9hUYN5xMrvyhqlFQ3QTmu11OcoqFgSnWAcYkN6abg=
github.com/nikhilsbhat/common v0.0.5-0.20240331064442-d5f43095b010 h1:TuR/lpOOwNt/uqJp/uhxT+K4MNZkHrbo0NMZSSKyX5c=
github.com/nikhilsbhat/common v0.0.5-0.20240331064442-d5f43095b010/go.mod h1:ldoLjRsIaskDbouPaQ0ujVKbW8su3mI1MPQIaD24twQ=
github.com/nikhilsbhat/common v0.0.5 h1:zYpezmwvUKLlreHAeWOCzWHzHGqE81zdyVsWH+V3DsM=
github.com/nikhilsbhat/common v0.0.5/go.mod h1:CpYvxevW+ZpSWFrxzpzPgDHdKlFeE3rCHXNufJgygG4=
github.com/nikhilsbhat/gocd-sdk-go v0.1.9 h1:QG16EwKhxocn0Imza6S+/lE8S0MOw54UDebfJotQx2s=
Expand Down

0 comments on commit 2fc151d

Please sign in to comment.