cmd

package
v0.46.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 9, 2025 License: Apache-2.0 Imports: 50 Imported by: 2

Documentation

Overview

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Index

Constants

This section is empty.

Variables

View Source 
var (

	// LogLevelCLI holds the log level as input from a command
	LogLevelCLI string
	// LogFormat holds the log format as input from a command
	LogFormat string
	// SkipLogFile is a flag to skip logging to a file
	SkipLogFile bool
	// NoColor is a flag to disable colors in output
	NoColor bool
	// OutputWriter provides a default writer to Stdout for user-facing command output
	OutputWriter = os.Stdout
)

Functions

func Execute 

func Execute(ctx context.Context)

Execute is the entrypoint for the CLI.

func NewConnectCommand added in v0.46.0 

func NewConnectCommand() *cobra.Command

NewConnectCommand creates the `connect` sub-command and its nested children.

func NewConnectListCommand added in v0.46.0 

func NewConnectListCommand() *cobra.Command

NewConnectListCommand creates the `connect list` sub-command.

func NewDestroyCommand added in v0.46.0 

func NewDestroyCommand() *cobra.Command

NewDestroyCommand creates the `destroy` sub-command.

func NewDevCommand added in v0.46.0 

func NewDevCommand() *cobra.Command

NewDevCommand creates the `dev` sub-command and its nested children.

func NewDevDeployCommand added in v0.46.0 

func NewDevDeployCommand(v *viper.Viper) *cobra.Command

NewDevDeployCommand creates the `dev deploy` sub-command.

func NewDevFindImagesCommand added in v0.46.0 

func NewDevFindImagesCommand(v *viper.Viper) *cobra.Command

NewDevFindImagesCommand creates the `dev find-images` sub-command.

func NewDevGenerateCommand added in v0.46.0 

func NewDevGenerateCommand() *cobra.Command

NewDevGenerateCommand creates the `dev generate` sub-command.

func NewDevGenerateConfigCommand added in v0.46.0 

func NewDevGenerateConfigCommand() *cobra.Command

NewDevGenerateConfigCommand creates the `dev generate-config` sub-command.

func NewDevLintCommand added in v0.46.0 

func NewDevLintCommand(v *viper.Viper) *cobra.Command

NewDevLintCommand creates the `dev lint` sub-command.

func NewDevPatchGitCommand added in v0.46.0 

func NewDevPatchGitCommand() *cobra.Command

NewDevPatchGitCommand creates the `dev patch-git` sub-command.

func NewDevSha256SumCommand added in v0.46.0 

func NewDevSha256SumCommand() *cobra.Command

NewDevSha256SumCommand creates the `dev sha256sum` sub-command.

func NewInitCommand added in v0.46.0 

func NewInitCommand() *cobra.Command

NewInitCommand creates the `init` sub-command.

func NewInternalAgentCommand added in v0.46.0 

func NewInternalAgentCommand() *cobra.Command

NewInternalAgentCommand creates the `internal agent` sub-command.

func NewInternalCommand added in v0.46.0 

func NewInternalCommand(rootCmd *cobra.Command) *cobra.Command

NewInternalCommand creates the `internal` sub-command and its nested children.

func NewInternalCrc32Command added in v0.46.0 

func NewInternalCrc32Command() *cobra.Command

NewInternalCrc32Command creates the `internal crc32` sub-command.

func NewInternalCreateArtifactRegistryTokenCommand added in v0.46.0 

func NewInternalCreateArtifactRegistryTokenCommand() *cobra.Command

NewInternalCreateArtifactRegistryTokenCommand creates the `internal create-artifact-registry-token` sub-command.

func NewInternalCreateReadOnlyGiteaUserCommand added in v0.46.0 

func NewInternalCreateReadOnlyGiteaUserCommand() *cobra.Command

NewInternalCreateReadOnlyGiteaUserCommand creates the `internal create-read-oly-gitea-user` sub-command.

func NewInternalGenCliDocsCommand added in v0.46.0 

func NewInternalGenCliDocsCommand(root *cobra.Command) *cobra.Command

NewInternalGenCliDocsCommand creates the `internal gen-cli-docs` sub-command.

func NewInternalHTTPProxyCommand added in v0.46.0 

func NewInternalHTTPProxyCommand() *cobra.Command

NewInternalHTTPProxyCommand creates the `internal http-proxy` sub-command.

func NewInternalIsValidHostnameCommand added in v0.46.0 

func NewInternalIsValidHostnameCommand() *cobra.Command

NewInternalIsValidHostnameCommand creates the `internal is-valid-hostname` sub-command.

func NewInternalUpdateGiteaPVCCommand added in v0.46.0 

func NewInternalUpdateGiteaPVCCommand() *cobra.Command

NewInternalUpdateGiteaPVCCommand creates the `internal update-gitea-pvc` sub-command.

func NewPackageCommand added in v0.46.0 

func NewPackageCommand() *cobra.Command

NewPackageCommand creates the `package` sub-command and its nested children.

func NewPackageCreateCommand added in v0.46.0 

func NewPackageCreateCommand(v *viper.Viper) *cobra.Command

NewPackageCreateCommand creates the `package create` sub-command.

func NewPackageDeployCommand added in v0.46.0 

func NewPackageDeployCommand(v *viper.Viper) *cobra.Command

NewPackageDeployCommand creates the `package deploy` sub-command.

func NewPackageInspectCommand added in v0.46.0 

func NewPackageInspectCommand() *cobra.Command

NewPackageInspectCommand creates the `package inspect` sub-command.

func NewPackageListCommand added in v0.46.0 

func NewPackageListCommand() *cobra.Command

NewPackageListCommand creates the `package list` sub-command.

func NewPackageMirrorResourcesCommand added in v0.46.0 

func NewPackageMirrorResourcesCommand(v *viper.Viper) *cobra.Command

NewPackageMirrorResourcesCommand creates the `package mirror-resources` sub-command.

func NewPackagePublishCommand added in v0.46.0 

func NewPackagePublishCommand(v *viper.Viper) *cobra.Command

NewPackagePublishCommand creates the `package publish` sub-command.

func NewPackagePullCommand added in v0.46.0 

func NewPackagePullCommand(v *viper.Viper) *cobra.Command

NewPackagePullCommand creates the `package pull` sub-command.

func NewPackageRemoveCommand added in v0.46.0 

func NewPackageRemoveCommand(v *viper.Viper) *cobra.Command

NewPackageRemoveCommand creates the `package remove` sub-command.

func NewVersionCommand added in v0.46.0 

func NewVersionCommand() *cobra.Command

NewVersionCommand creates the `version` sub-command.

func NewZarfCommand added in v0.46.0 

func NewZarfCommand() *cobra.Command

NewZarfCommand creates the `zarf` command and its nested children.

func SetupMessage added in v0.43.0 

func SetupMessage(cfg MessageCfg) error

SetupMessage configures message while we migrate over to logger.

Types

type ConnectListOptions added in v0.46.0 

type ConnectListOptions struct{}

ConnectListOptions holds the command-line options for 'connect list' sub-command.

func (*ConnectListOptions) Run added in v0.46.0 

func (o *ConnectListOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'connect list' sub-command.

type ConnectOptions added in v0.46.0 

type ConnectOptions struct {
	// contains filtered or unexported fields
}

ConnectOptions holds the command-line options for 'connect' sub-command.

func (*ConnectOptions) Run added in v0.46.0 

func (o *ConnectOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'connect' sub command.

type DestroyOptions added in v0.46.0 

type DestroyOptions struct {
	// contains filtered or unexported fields
}

DestroyOptions holds the command-line options for 'destroy' sub-command.

func (*DestroyOptions) Run added in v0.46.0 

func (o *DestroyOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'destroy' sub-command.

type DevDeployOptions added in v0.46.0 

type DevDeployOptions struct{}

DevDeployOptions holds the command-line options for 'dev deploy' sub-command.

func (*DevDeployOptions) Run added in v0.46.0 

func (o *DevDeployOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'dev deploy' sub-command.

type DevFindImagesOptions added in v0.46.0 

type DevFindImagesOptions struct{}

DevFindImagesOptions holds the command-line options for 'dev find-images' sub-command.

func (*DevFindImagesOptions) Run added in v0.46.0 

func (o *DevFindImagesOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'dev find-images' sub-command.

type DevGenerateConfigOptions added in v0.46.0 

type DevGenerateConfigOptions struct{}

DevGenerateConfigOptions holds the command-line options for 'dev generate-config' sub-command.

func (*DevGenerateConfigOptions) Run added in v0.46.0 

func (o *DevGenerateConfigOptions) Run(_ *cobra.Command, args []string) error

Run performs the execution of 'dev generate-config' sub-command.

type DevGenerateOptions added in v0.46.0 

type DevGenerateOptions struct{}

DevGenerateOptions holds the command-line options for 'dev generate' sub-command.

func (*DevGenerateOptions) Run added in v0.46.0 

func (o *DevGenerateOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'dev generate' sub-command.

type DevLintOptions added in v0.46.0 

type DevLintOptions struct{}

DevLintOptions holds the command-line options for 'dev lint' sub-command.

func (*DevLintOptions) Run added in v0.46.0 

func (o *DevLintOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'dev lint' sub-command.

type DevPatchGitOptions added in v0.46.0 

type DevPatchGitOptions struct{}

DevPatchGitOptions holds the command-line options for 'dev patch-git' sub-command.

func (*DevPatchGitOptions) Run added in v0.46.0 

func (o *DevPatchGitOptions) Run(_ *cobra.Command, args []string) error

Run performs the execution of 'dev patch-git' sub-command.

type DevSha256SumOptions added in v0.46.0 

type DevSha256SumOptions struct {
	// contains filtered or unexported fields
}

DevSha256SumOptions holds the command-line options for 'dev sha256sum' sub-command.

func (*DevSha256SumOptions) Run added in v0.46.0 

func (o *DevSha256SumOptions) Run(cmd *cobra.Command, args []string) (err error)

Run performs the execution of 'dev sha256sum' sub-command.

type InitOptions added in v0.46.0 

type InitOptions struct{}

InitOptions holds the command-line options for 'init' sub-command.

func (*InitOptions) Run added in v0.46.0 

func (o *InitOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'init' sub-command.

type InternalAgentOptions added in v0.46.0 

type InternalAgentOptions struct{}

InternalAgentOptions holds the command-line options for 'internal agent' sub-command.

func (*InternalAgentOptions) Run added in v0.46.0 

func (o *InternalAgentOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'internal agent' sub-command.

type InternalCrc32Options added in v0.46.0 

type InternalCrc32Options struct{}

InternalCrc32Options holds the command-line options for 'intenral crc32' sub-command.

func (*InternalCrc32Options) Run added in v0.46.0 

func (o *InternalCrc32Options) Run(_ *cobra.Command, args []string)

Run performs the execution of 'internal crc32' sub-command.

type InternalCreateArtifactRegistryTokenOptions added in v0.46.0 

type InternalCreateArtifactRegistryTokenOptions struct{}

InternalCreateArtifactRegistryTokenOptions holds the command-line options for 'internal create-artifact-registry-token' sub-command.

func (*InternalCreateArtifactRegistryTokenOptions) Run added in v0.46.0 

func (o *InternalCreateArtifactRegistryTokenOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'internal create-artifact-registry-token' sub-command.

type InternalCreateReadOnlyGiteaUserOptions added in v0.46.0 

type InternalCreateReadOnlyGiteaUserOptions struct{}

InternalCreateReadOnlyGiteaUserOptions holds the command-line options for 'internal create-read-only-gitea-user' sub-command.

func (*InternalCreateReadOnlyGiteaUserOptions) Run added in v0.46.0 

func (o *InternalCreateReadOnlyGiteaUserOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'internal create-read-only-gitea-user' sub-command.

type InternalGenCliDocsOptions added in v0.46.0 

type InternalGenCliDocsOptions struct {
	// contains filtered or unexported fields
}

InternalGenCliDocsOptions holds the command-line options for 'internal gen-cli-docs' sub-command.

func (*InternalGenCliDocsOptions) Run added in v0.46.0 

func (o *InternalGenCliDocsOptions) Run(_ *cobra.Command, _ []string) error

Run performs the execution of 'internal gen-cli-docs' sub-command.

type InternalHTTPProxyOptions added in v0.46.0 

type InternalHTTPProxyOptions struct{}

InternalHTTPProxyOptions holds the command-line options for 'internal http-proxy' sub-command.

func (*InternalHTTPProxyOptions) Run added in v0.46.0 

func (o *InternalHTTPProxyOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'internal http-proxy' sub-command.

type InternalIsValidHostnameOptions added in v0.46.0 

type InternalIsValidHostnameOptions struct{}

InternalIsValidHostnameOptions holds the command-line options for 'internal is-valid-hostname' sub-command.

func (*InternalIsValidHostnameOptions) Run added in v0.46.0 

func (o *InternalIsValidHostnameOptions) Run(_ *cobra.Command, _ []string) error

Run performs the execution of 'internal is-valid-hostname' sub-command.

type InternalUpdateGiteaPVCOptions added in v0.46.0 

type InternalUpdateGiteaPVCOptions struct {
	// contains filtered or unexported fields
}

InternalUpdateGiteaPVCOptions holds the command-line options for 'internal update-gitea-pvc' sub-command.

func (*InternalUpdateGiteaPVCOptions) Run added in v0.46.0 

func (o *InternalUpdateGiteaPVCOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'internal update-gitea-pvc' sub-command.

type MessageCfg added in v0.43.0 

type MessageCfg struct {
	Level       string
	SkipLogFile bool
	NoColor     bool
	// FeatureDisabled is a feature flag that disables it
	FeatureDisabled bool
}

MessageCfg is used to configure the Message package output options.

type PackageCreateOptions added in v0.46.0 

type PackageCreateOptions struct{}

PackageCreateOptions holds the command-line options for 'package create' sub-command.

func (*PackageCreateOptions) Run added in v0.46.0 

func (o *PackageCreateOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'package create' sub-command.

type PackageDeployOptions added in v0.46.0 

type PackageDeployOptions struct{}

PackageDeployOptions holds the command-line options for 'package deploy' sub-command.

func (*PackageDeployOptions) PreRun added in v0.46.0 

func (o *PackageDeployOptions) PreRun(_ *cobra.Command, _ []string)

PreRun performs the pre-run checks for 'package deploy' sub-command.

func (*PackageDeployOptions) Run added in v0.46.0 

func (o *PackageDeployOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'package deploy' sub-command.

type PackageInspectOptions added in v0.46.0 

type PackageInspectOptions struct{}

PackageInspectOptions holds the command-line options for 'package inspect' sub-command.

func (*PackageInspectOptions) PreRun added in v0.46.0 

func (o *PackageInspectOptions) PreRun(_ *cobra.Command, _ []string)

PreRun performs the pre-run checks for 'package inspect' sub-command.

func (*PackageInspectOptions) Run added in v0.46.0 

func (o *PackageInspectOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'package inspect' sub-command.

type PackageListOptions added in v0.46.0 

type PackageListOptions struct{}

PackageListOptions holds the command-line options for 'package list' sub-command.

func (*PackageListOptions) Run added in v0.46.0 

func (o *PackageListOptions) Run(cmd *cobra.Command, _ []string) error

Run performs the execution of 'package list' sub-command.

type PackageMirrorResourcesOptions added in v0.46.0 

type PackageMirrorResourcesOptions struct{}

PackageMirrorResourcesOptions holds the command-line options for 'package mirror-resources' sub-command.

func (*PackageMirrorResourcesOptions) PreRun added in v0.46.0 

func (o *PackageMirrorResourcesOptions) PreRun(_ *cobra.Command, _ []string)

PreRun performs the pre-run checks for 'package mirror-resources' sub-command.

func (*PackageMirrorResourcesOptions) Run added in v0.46.0 

func (o *PackageMirrorResourcesOptions) Run(cmd *cobra.Command, args []string) (err error)

Run performs the execution of 'package mirror-resources' sub-command.

type PackagePublishOptions added in v0.46.0 

type PackagePublishOptions struct{}

PackagePublishOptions holds the command-line options for 'package publish' sub-command.

func (*PackagePublishOptions) PreRun added in v0.46.0 

func (o *PackagePublishOptions) PreRun(_ *cobra.Command, _ []string)

PreRun performs the pre-run checks for 'package publish' sub-command.

func (*PackagePublishOptions) Run added in v0.46.0 

func (o *PackagePublishOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'package publish' sub-command.

type PackagePullOptions added in v0.46.0 

type PackagePullOptions struct{}

PackagePullOptions holds the command-line options for 'package pull' sub-command.

func (*PackagePullOptions) Run added in v0.46.0 

func (o *PackagePullOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'package pull' sub-command.

type PackageRemoveOptions added in v0.46.0 

type PackageRemoveOptions struct{}

PackageRemoveOptions holds the command-line options for 'package remove' sub-command.

func (*PackageRemoveOptions) PreRun added in v0.46.0 

func (o *PackageRemoveOptions) PreRun(_ *cobra.Command, _ []string)

PreRun performs the pre-run checks for 'package remove' sub-command.

func (*PackageRemoveOptions) Run added in v0.46.0 

func (o *PackageRemoveOptions) Run(cmd *cobra.Command, args []string) error

Run performs the execution of 'package remove' sub-command.

type VersionOptions added in v0.46.0 

type VersionOptions struct {
	// contains filtered or unexported fields
}

VersionOptions holds the command-line options for 'version' sub-command.

func (*VersionOptions) Run added in v0.46.0 

func (o *VersionOptions) Run(_ *cobra.Command, _ []string) error

Run performs the execution of 'version' sub-command.

Source Files

View all Source files

Directories

Path Synopsis
Package common handles command configuration across all commands
 Package common handles command configuration across all commands
Package say prints out the adorable creature we all know and love.
 Package say prints out the adorable creature we all know and love.
Package tools contains the CLI commands for Zarf.
 Package tools contains the CLI commands for Zarf.
helm
Package helm is a copy of the main package from helm to include a subset of the helm CLI in Zarf
 Package helm is a copy of the main package from helm to include a subset of the helm CLI in Zarf

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.