cmd

Documentation

Index

• Constants
• func Execute()
• func Format(obj interface{}, format string) (data []byte, err error)
• type BatchOption
  • func (b *BatchOption) Confirm(message string) bool
  • func (b *BatchOption) SetFlag(cmd *cobra.Command)
• type CenterOption
• type CenterWatchOption
• type Config
• type ConfigAddOptions
• type ConfigGenerateOption
• type ConfigOptions
• type CrumbIssuer
• type CrumbIssuerOptions
• type FormatOutput
• type InteractiveOption
  • func (b *InteractiveOption) SetFlag(cmd *cobra.Command)
• type JenkinsServer
• type JobBuildOption
• type JobCreateOption
• type JobDeleteOption
• type JobHistoryOption
  • func (o *JobHistoryOption) Output(obj interface{}) (data []byte, err error)
• type JobLogOption
• type JobOption
• type JobParamOption
• type JobSearchOption
• type JobStopOption
• type JobTypeOption
  • func (o *JobTypeOption) Output(obj interface{}) (data []byte, err error)
• type OpenOption
• type OutputOption
  • func (o *OutputOption) Output(obj interface{}) (data []byte, err error)
  • func (o *OutputOption) SetFlag(cmd *cobra.Command)
• type PluginListOption
  • func (o *PluginListOption) Output(obj interface{}) (data []byte, err error)
• type PluginOptions
• type PluginSearchOption
  • func (o *PluginSearchOption) Output(obj interface{}) (data []byte, err error)
• type PluginSuite
• type PluginUploadOption
• type PreHook
• type QueueOption
• type RestartOption
• type RootOptions
• type UserCreateOption
• type UserDeleteOption
• type UserEditOption
• type UserOption
• type UserTokenOption
• type WatchOption

Constants

const (
	JsonOutputFormat  string = "json"
	YAMLOutputFormat  string = "yaml"
	TableOutputFormat string = "table"
)

Functions

func Execute

func Execute()

func Format

func Format(obj interface{}, format string) (data []byte, err error)

Types

type BatchOption

type BatchOption struct {
	Batch bool
}

BatchOption represent the options for a batch operation

func (*BatchOption) Confirm

func (b *BatchOption) Confirm(message string) bool

Confirm prompte user if they really want to do this

func (*BatchOption) SetFlag

func (b *BatchOption) SetFlag(cmd *cobra.Command)

type CenterOption

type CenterOption struct {
	WatchOption

	CeneterStatus string
}

type CenterWatchOption

type CenterWatchOption struct {
	WatchOption

	CeneterStatus string
}

CenterWatchOption as the options of watch command

type Config

type Config struct {
	Current        string          `yaml:"current"`
	JenkinsServers []JenkinsServer `yaml:"jenkins_servers"`
	PreHooks       []PreHook       `yaml:"preHooks"`
	PluginSuites   []PluginSuite   `yaml:"pluginSuites"`
}

type ConfigAddOptions

type ConfigAddOptions struct {
	JenkinsServer
}

type ConfigGenerateOption

type ConfigGenerateOption struct {
	Copy bool
}

type ConfigOptions

type ConfigOptions struct {
	ConfigFileLocation string
}

type CrumbIssuer

type CrumbIssuer struct {
	Crumb             string `json:"crumb"`
	CrumbRequestField string `json:"crumbRequestField"`
}

type CrumbIssuerOptions

type CrumbIssuerOptions struct {
	Upload bool
}

Start contains the command line options

type FormatOutput

type FormatOutput interface {
	Output(obj interface{}, format string) (data []byte, err error)
}

type InteractiveOption

type InteractiveOption struct {
	Interactive bool
}

InteractiveOption allow user to choose whether the mode is interactive

func (*InteractiveOption) SetFlag

func (b *InteractiveOption) SetFlag(cmd *cobra.Command)

SetFlag set the option flag to this cmd

type JenkinsServer

type JenkinsServer struct {
	Name        string `yaml:"name"`
	URL         string `yaml:"url"`
	UserName    string `yaml:"username"`
	Token       string `yaml:"token"`
	Proxy       string `yaml:"proxy"`
	ProxyAuth   string `yaml:"proxyAuth"`
	Description string `yaml:"description"`
}

JenkinsServer holds the configuration of your Jenkins

type JobBuildOption

type JobBuildOption struct {
	BatchOption

	Param string
	Debug bool
}

type JobCreateOption

type JobCreateOption struct {
}

type JobDeleteOption

type JobDeleteOption struct {
	BatchOption
}

type JobHistoryOption

type JobHistoryOption struct {
	OutputOption
}

func (*JobHistoryOption) Output

func (o *JobHistoryOption) Output(obj interface{}) (data []byte, err error)

type JobLogOption

type JobLogOption struct {
	WatchOption
	History int

	LogText      string
	LastBuildID  int
	LastBuildURL string
}

type JobOption

type JobOption struct {
	OutputOption
}

type JobParamOption

type JobParamOption struct {
	OutputOption

	Indent bool
}

type JobSearchOption

type JobSearchOption struct {
	OutputOption
}

type JobStopOption

type JobStopOption struct {
	BatchOption
}

type JobTypeOption

type JobTypeOption struct {
	OutputOption
}

func (*JobTypeOption) Output

func (o *JobTypeOption) Output(obj interface{}) (data []byte, err error)

type OpenOption

type OpenOption struct {
	InteractiveOption

	Name   string
	Config bool
}

type OutputOption

type OutputOption struct {
	Format string
}

OutputOption represent the format of output

func (*OutputOption) Output

func (o *OutputOption) Output(obj interface{}) (data []byte, err error)

func (*OutputOption) SetFlag

func (o *OutputOption) SetFlag(cmd *cobra.Command)

type PluginListOption

type PluginListOption struct {
	OutputOption

	Filter []string
}

func (*PluginListOption) Output

func (o *PluginListOption) Output(obj interface{}) (data []byte, err error)

type PluginOptions

type PluginOptions struct {
	Suite string
}

PluginOptions contains the command line options

type PluginSearchOption

type PluginSearchOption struct {
	OutputOption
}

func (*PluginSearchOption) Output

func (o *PluginSearchOption) Output(obj interface{}) (data []byte, err error)

type PluginSuite

type PluginSuite struct {
	Name        string   `yaml:"name"`
	Plugins     []string `yaml:"plugins"`
	Description string   `yaml:"description"`
}

PluginSuite define a suite of plugins

type PluginUploadOption

type PluginUploadOption struct {
	Remote         string
	RemoteUser     string
	RemotePassword string
	RemoteJenkins  string
	// contains filtered or unexported fields
}

PluginUploadOption will hold the options of plugin cmd

type PreHook

type PreHook struct {
	Path    string `yaml:"path"`
	Command string `yaml:"cmd"`
}

type QueueOption

type QueueOption struct {
	OutputOption
}

type RestartOption

type RestartOption struct {
	BatchOption
}

RestartOption holds the options for restart cmd

type RootOptions

type RootOptions struct {
	Jenkins string
	Version bool
	Debug   bool
}

RootOptions is a global option for whole cli

type UserCreateOption

type UserCreateOption struct {
}

type UserDeleteOption

type UserDeleteOption struct {
	BatchOption
}

type UserEditOption

type UserEditOption struct {
	Description bool
}

type UserOption

type UserOption struct {
	OutputOption
}

type UserTokenOption

type UserTokenOption struct {
	Generate bool
	Name     string
}

type WatchOption

type WatchOption struct {
	Watch    bool
	Interval int
}

WatchOption for the resources which can be watched