jx: github.com/jenkins-x/jx/pkg/cmd Index | Files | Directories

package cmd

import "github.com/jenkins-x/jx/pkg/cmd"

Index

Package Files

cmd.go completion.go console.go context.go diagnose.go docs.go environment.go logs.go metrics.go open.go options.go prompt.go repository.go scan.go scan_cluster.go shell.go status.go step.go team.go version.go

Constants

const (
    BlueOceanPath = "/blue"
)

Variables

var (
    MetricsLong = templates.LongDesc(`
		Gets the metrics of the newest pod for a Deployment.

`)

    MetricsExample = templates.Examples("" /* 189 byte string literal not displayed */,
    )
)
var (
    StatusLong = templates.LongDesc(`
		Gets the current status of the Kubernetes cluster

`)

    StatusExample = templates.Examples(`
		# displays the current status of the Kubernetes cluster
		jx status
`)
)

func NewCmdCompletion Uses

func NewCmdCompletion(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdConsole Uses

func NewCmdConsole(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdContext Uses

func NewCmdContext(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdDiagnose Uses

func NewCmdDiagnose(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdDocs Uses

func NewCmdDocs(commonOpts *opts.CommonOptions) *cobra.Command

open the docs - Jenkins X docs by default

func NewCmdEnvironment Uses

func NewCmdEnvironment(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdLogs Uses

func NewCmdLogs(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdMetrics Uses

func NewCmdMetrics(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdOpen Uses

func NewCmdOpen(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdOptions Uses

func NewCmdOptions(out io.Writer) *cobra.Command

NewCmdOptions implements the options command

func NewCmdPrompt Uses

func NewCmdPrompt(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdPrompt creates the new command for: jx get prompt

func NewCmdRepo Uses

func NewCmdRepo(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdScan Uses

func NewCmdScan(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdScan creates a command object for the "scan" command

func NewCmdScanCluster Uses

func NewCmdScanCluster(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdScanCluster creates a command object for "scan cluster" command

func NewCmdShell Uses

func NewCmdShell(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStatus Uses

func NewCmdStatus(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdStep Uses

func NewCmdStep(commonOpts *opts.CommonOptions) *cobra.Command

NewCmdStep Steps a command object for the "step" command

func NewCmdTeam Uses

func NewCmdTeam(commonOpts *opts.CommonOptions) *cobra.Command

func NewCmdVersion Uses

func NewCmdVersion(commonOpts *opts.CommonOptions) *cobra.Command

func NewJXCommand Uses

func NewJXCommand(f clients.Factory, in terminal.FileReader, out terminal.FileWriter,
    err io.Writer, args []string) *cobra.Command

NewJXCommand creates the `jx` command and its nested children. args used to determine binary plugin to run can be overridden (does not affect compiled in commands).

type CompletionOptions Uses

type CompletionOptions struct {
    *opts.CommonOptions
}

CompletionOptions options for completion command

func (*CompletionOptions) Run Uses

func (o *CompletionOptions) Run() error

Run executes the completion command

type ConsoleOptions Uses

type ConsoleOptions struct {
    get.GetURLOptions

    OnlyViewURL     bool
    ClassicMode     bool
    JenkinsSelector opts.JenkinsSelectorOptions
}

func (*ConsoleOptions) Open Uses

func (o *ConsoleOptions) Open(name string, label string) error

func (*ConsoleOptions) Run Uses

func (o *ConsoleOptions) Run() error

type ContextOptions Uses

type ContextOptions struct {
    *opts.CommonOptions

    Filter string
}

func (*ContextOptions) PickContext Uses

func (o *ContextOptions) PickContext(names []string, defaultValue string) (string, error)

func (*ContextOptions) Run Uses

func (o *ContextOptions) Run() error

type DiagnoseOptions Uses

type DiagnoseOptions struct {
    *opts.CommonOptions
    Namespace string
    Show      []string
}

func (*DiagnoseOptions) Run Uses

func (o *DiagnoseOptions) Run() error

type EnvironmentOptions Uses

type EnvironmentOptions struct {
    *opts.CommonOptions
}

func (*EnvironmentOptions) PickNamespace Uses

func (o *EnvironmentOptions) PickNamespace(client kubernetes.Interface, defaultNamespace string) (string, error)

func (*EnvironmentOptions) Run Uses

func (o *EnvironmentOptions) Run() error

type LogsOptions Uses

type LogsOptions struct {
    *opts.CommonOptions

    Container       string
    Namespace       string
    Environment     string
    Filter          string
    Label           string
    EditEnvironment bool
    KNativeBuild    bool
}

func (*LogsOptions) Run Uses

func (o *LogsOptions) Run() error

type MetricsOptions Uses

type MetricsOptions struct {
    *opts.CommonOptions

    Namespace string
    Filter    string
    Duration  string
    Selector  string
    Metric    string
}

func (*MetricsOptions) Run Uses

func (o *MetricsOptions) Run() error

type OpenOptions Uses

type OpenOptions struct {
    ConsoleOptions
}

func (*OpenOptions) Run Uses

func (o *OpenOptions) Run() error

type PluginHandler Uses

type PluginHandler interface {
    // Lookup receives a potential filename and returns
    // a full or relative path to an executable, if one
    // exists at the given filename, or an error.
    Lookup(filename string) (string, error)
    // Execute receives an executable's filepath, a slice
    // of arguments, and a slice of environment variables
    // to relay to the executable.
    Execute(executablePath string, cmdArgs, environment []string) error
}

PluginHandler is capable of parsing command line arguments and performing executable filename lookups to search for valid plugin files, and execute found plugins.

type PromptOptions Uses

type PromptOptions struct {
    *opts.CommonOptions

    NoLabel  bool
    ShowIcon bool

    Prefix    string
    Label     string
    Separator string
    Divider   string
    Suffix    string

    LabelColor     []string
    NamespaceColor []string
    ContextColor   []string
}

PromptOptions containers the CLI options

func (*PromptOptions) Run Uses

func (o *PromptOptions) Run() error

Run implements this command

type RepoOptions Uses

type RepoOptions struct {
    *opts.CommonOptions

    Dir         string
    OnlyViewURL bool
    Quiet       bool
}

func (*RepoOptions) Run Uses

func (o *RepoOptions) Run() error

type ScanClusterOptions Uses

type ScanClusterOptions struct {
    ScanOptions

    Output string
}

ScanClusterOptions the options for 'scan cluster' command

func (*ScanClusterOptions) Run Uses

func (o *ScanClusterOptions) Run() error

Run executes the "scan cluster" command

type ScanOptions Uses

type ScanOptions struct {
    *opts.CommonOptions
}

Scan Options contains the command line options for scan commands

func (*ScanOptions) Run Uses

func (o *ScanOptions) Run() error

Run executes the scan commands

type ShellOptions Uses

type ShellOptions struct {
    *opts.CommonOptions

    Filter string
}

func (*ShellOptions) PickContext Uses

func (o *ShellOptions) PickContext(names []string, defaultValue string) (string, error)

func (*ShellOptions) Run Uses

func (o *ShellOptions) Run() error

type StatusOptions Uses

type StatusOptions struct {
    *opts.CommonOptions
    // contains filtered or unexported fields
}

func (*StatusOptions) Run Uses

func (o *StatusOptions) Run() error

type TeamOptions Uses

type TeamOptions struct {
    *opts.CommonOptions
}

func (*TeamOptions) Run Uses

func (o *TeamOptions) Run() error

type VersionOptions Uses

type VersionOptions struct {
    *opts.CommonOptions

    Container      string
    Namespace      string
    HelmTLS        bool
    NoVersionCheck bool
    NoVerify       bool
}

func (*VersionOptions) GetOsVersion Uses

func (o *VersionOptions) GetOsVersion() (string, error)

GetOsVersion returns a human friendly string of the current OS in the case of an error this still returns a valid string for the details that can be found.

func (*VersionOptions) Run Uses

func (o *VersionOptions) Run() error

Directories

PathSynopsis
add
boot
clients
clients/fake
clients/mocks
compliance
config
controller
controller/pipeline
create
deletecmd
edit
edit/requirements
gc
get
helper
importcmd
initcmd
namespace
opts
opts/step
opts/upgrade
preview
profile
promote
rsh
start
step
step/bdd
step/boot
step/buildpack
step/cluster
step/create
step/create/pr
step/e2e
step/env
step/expose
step/get
step/git
step/helm
step/nexus
step/post
step/pr
step/pre
step/report
step/scheduler
step/syntax
step/update
step/update/release
step/verify
stop
sync
templates
testhelpers
uninstall
update
upgrade

Package cmd imports 87 packages (graph) and is imported by 1 packages. Updated 2019-11-17. Refresh now. Tools for package owners.