Skip to content

Commit

Permalink
update README and dependencies
Browse files Browse the repository at this point in the history
Signed-off-by: Jeeva Kandasamy <[email protected]>
  • Loading branch information
jkandasa committed Jan 20, 2022
1 parent d234fb3 commit 0240515
Show file tree
Hide file tree
Showing 4 changed files with 614 additions and 91 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,39 @@ Inspired by `kubectl` and `oc` (OpenShift) client.
* [Releases](https://github.com/jkandasa/jenkinsctl/releases/latest)
* [Pre Release](https://github.com/jkandasa/jenkinsctl/releases/tag/master) - `master` branch build

### Commands
```
$ jenkinsctl --help
Jenkins Client
This client helps you to control your jenkins server from command line.
Usage:
jenkinsctl [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
create Create a resource from a file or stdin
download Download resources from Jenkins server
get Display one or many resources
help Help about any command
job Switch or set a job
jobs Display existing jobs
login Log in to a server
logout Log out from a server
status Displays an overview of the jenkins server
version Print the client and server version information
Flags:
--config string config file (default is $HOME/.jenkinsctl.yaml)
-h, --help help for jenkinsctl
--hide-header hides the header on the console output
-j, --job string Switch to another job
-o, --output string output format. options: yaml, json, console (default "console")
--pretty JSON pretty print
Use "jenkinsctl [command] --help" for more information about a command.
```
### Examples
To get login token,
> The API token is available in your personal configuration page. Click your name on the top right corner on every page, then click "Configure" to see your API token. (The URL `$root/me/configure` is a good shortcut.) You can also change your API token from here.
Expand Down
2 changes: 1 addition & 1 deletion cmd/command/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func init() {

var createResource = &cobra.Command{
Use: "create",
Short: "Create a resource from a file",
Short: "Create a resource from a file or stdin",
Example: ` # create a build using the date in yaml file
jenkinsctl create -f my_build.yaml
Expand Down
25 changes: 22 additions & 3 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
module github.com/jkandasa/jenkinsctl

go 1.16
go 1.17

require (
github.com/bndr/gojenkins v1.1.0
github.com/fatih/structs v1.1.0
github.com/mitchellh/go-homedir v1.1.0
github.com/olekukonko/tablewriter v0.0.5
github.com/spf13/cobra v1.1.3
github.com/spf13/viper v1.7.0
github.com/spf13/cobra v1.3.0
github.com/spf13/viper v1.10.1
gopkg.in/yaml.v2 v2.4.0
)

require (
github.com/fsnotify/fsnotify v1.5.1 // indirect
github.com/hashicorp/hcl v1.0.0 // indirect
github.com/inconshreveable/mousetrap v1.0.0 // indirect
github.com/magiconair/properties v1.8.5 // indirect
github.com/mattn/go-runewidth v0.0.9 // indirect
github.com/mitchellh/mapstructure v1.4.3 // indirect
github.com/pelletier/go-toml v1.9.4 // indirect
github.com/spf13/afero v1.6.0 // indirect
github.com/spf13/cast v1.4.1 // indirect
github.com/spf13/jwalterweatherman v1.1.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
github.com/subosito/gotenv v1.2.0 // indirect
golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d // indirect
golang.org/x/sys v0.0.0-20211210111614-af8b64212486 // indirect
golang.org/x/text v0.3.7 // indirect
gopkg.in/ini.v1 v1.66.2 // indirect
)
Loading

0 comments on commit 0240515

Please sign in to comment.