cmd

Documentation

Overview

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.

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.

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.

Package cmd contains the CLI commands for Zarf.

Package cmd contains the CLI commands for Zarf.

Index

• Constants
• Variables
• func Execute(ctx context.Context)
• func IsVendorCmd(args []string, vendoredCmds []string) bool
• func NewZarfCommand() *cobra.Command
• func PrintFindings(ctx context.Context, lintErr *lint.LintError)
• func PrintViperConfigUsed(ctx context.Context) error
• func SetupMessage(cfg MessageCfg) error
• type MessageCfg
• type PackageInspectSBOMOptions
  • func (o *PackageInspectSBOMOptions) Run(cmd *cobra.Command, args []string) error

Constants

const (
	VArchitecture          = "architecture"
	VZarfCache             = "zarf_cache"
	VTmpDir                = "tmp_dir"
	VInsecure              = "insecure"
	VPlainHTTP             = "plain_http"
	VInsecureSkipTLSVerify = "insecure_skip_tls_verify"

	VLogLevel   = "log_level"
	VLogFormat  = "log_format"
	VNoLogFile  = "no_log_file"
	VNoProgress = "no_progress"
	VNoColor    = "no_color"

	VInitComponents   = "init.components"
	VInitStorageClass = "init.storage_class"

	VInitGitURL      = "init.git.url"
	VInitGitPushUser = "init.git.push_username"
	VInitGitPushPass = "init.git.push_password"
	VInitGitPullUser = "init.git.pull_username"
	VInitGitPullPass = "init.git.pull_password"

	VInitRegistryURL      = "init.registry.url"
	VInitRegistryNodeport = "init.registry.nodeport"
	VInitRegistrySecret   = "init.registry.secret"
	VInitRegistryPushUser = "init.registry.push_username"
	VInitRegistryPushPass = "init.registry.push_password"
	VInitRegistryPullUser = "init.registry.pull_username"
	VInitRegistryPullPass = "init.registry.pull_password"

	VInitArtifactURL       = "init.artifact.url"
	VInitArtifactPushUser  = "init.artifact.push_username"
	VInitArtifactPushToken = "init.artifact.push_token"

	VPkgOCIConcurrency = "package.oci_concurrency"
	VPkgPublicKey      = "package.public_key"

	VPkgCreateSet                = "package.create.set"
	VPkgCreateOutput             = "package.create.output"
	VPkgCreateSbom               = "package.create.sbom"
	VPkgCreateSbomOutput         = "package.create.sbom_output"
	VPkgCreateSkipSbom           = "package.create.skip_sbom"
	VPkgCreateMaxPackageSize     = "package.create.max_package_size"
	VPkgCreateSigningKey         = "package.create.signing_key"
	VPkgCreateSigningKeyPassword = "package.create.signing_key_password"
	VPkgCreateDifferential       = "package.create.differential"
	VPkgCreateRegistryOverride   = "package.create.registry_override"
	VPkgCreateFlavor             = "package.create.flavor"

	VPkgDeploySet        = "package.deploy.set"
	VPkgDeployComponents = "package.deploy.components"
	VPkgDeployShasum     = "package.deploy.shasum"
	VPkgDeploySget       = "package.deploy.sget"
	VPkgDeployTimeout    = "package.deploy.timeout"
	VPkgRetries          = "package.deploy.retries"

	VPkgPublishSigningKey         = "package.publish.signing_key"
	VPkgPublishSigningKeyPassword = "package.publish.signing_key_password"

	VPkgPullOutputDir = "package.pull.output_directory"

	VDevDeployNoYolo = "dev.deploy.no_yolo"
)

Constants for use when loading configurations from viper config files

Variables

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 IsVendorCmd

func IsVendorCmd(args []string, vendoredCmds []string) bool

IsVendorCmd checks if the command is a vendor command.

func NewZarfCommand

func NewZarfCommand() *cobra.Command

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

func PrintFindings

func PrintFindings(ctx context.Context, lintErr *lint.LintError)

PrintFindings prints the findings in the LintError as a table.

func PrintViperConfigUsed

func PrintViperConfigUsed(ctx context.Context) error

PrintViperConfigUsed informs users when Zarf has detected a config file.

func SetupMessage

func SetupMessage(cfg MessageCfg) error

SetupMessage configures message while we migrate over to logger.

Types

type MessageCfg

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 PackageInspectSBOMOptions

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

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

func (*PackageInspectSBOMOptions) Run

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

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