Documentation
¶
Overview ¶
Package flag centralizes the definition of global CLI flags used across various earth subcommands.
Index ¶
Constants ¶
View Source
const ( // DefaultBuildkitdContainerSuffix is the suffix of the buildkitd container. DefaultBuildkitdContainerSuffix = "-buildkitd" // DefaultBuildkitdVolumeSuffix is the suffix of the docker volume used for storing the cache. DefaultBuildkitdVolumeSuffix = "-cache" // DefaultEnvFile is the default path to the env file. DefaultEnvFile = ".env" // EnvFileFlag is the flag for the env file path. EnvFileFlag = "env-file-path" // DefaultArgFile is the default path to the arg file. DefaultArgFile = ".arg" // ArgFileFlag is the flag for the arg file path. ArgFileFlag = "arg-file-path" // DefaultSecretFile is the default path to the secret file. DefaultSecretFile = ".secret" // SecretFileFlag is the flag for the secret file path. SecretFileFlag = "secret-file-path" )
Variables ¶
This section is empty.
Functions ¶
func EarthEnvVars ¶ added in v0.8.18
func EarthEnvVars(suffix string) cli.ValueSourceChain
EarthEnvVars returns a value source chain for the given env var suffix that accepts both the current EARTH_ prefix and the deprecated EARTHLY_ prefix, with EARTH_ taking precedence.
NOTE: the EARTHLY_ fallback is a temporary shim to support the EARTHLY_ -> EARTH_ migration. Once EARTHLY_ support is officially dropped, this helper can return cli.EnvVars(env.Prefix + suffix) (or be removed entirely in favour of cli.EnvVars).
Types ¶
type Global ¶
type Global struct {
FeatureFlagOverrides string
InstallationName string
GitUsernameOverride string
GitPasswordOverride string
GitBranchOverride string
ExecStatsSummary string
SSHAuthSock string
ArgFile string
EnvFile string
LocalRegistryHost string
ConfigPath string
DockerfilePath string
RemoteCache string
SecretFile string
LocalSkipDB string
LogstreamDebugFile string
LogstreamDebugManifestFile string
GitLFSPullInclude string
BuildkitHost string
BuildkitdImage string
ContainerName string
ContainerFrontend containerutil.ContainerFrontend
BuildkitdSettings buildkitd.Settings
ServerConnTimeout time.Duration
ConversionParallelism int
InteractiveDebugging bool
NoCache bool
NoBuildkitUpdate bool
DisplayExecStats bool
Debug bool
ArtifactMode bool
ImageMode bool
Pull bool
Push bool
CI bool
UseTickTockBuildkitImage bool
Output bool
NoOutput bool
BootstrapNoBuildkit bool
SkipBuildkit bool
AllowPrivileged bool
MaxRemoteCache bool
SaveInlineCache bool
UseInlineCache bool
NoFakeDep bool
Strict bool
GlobalWaitEnd bool
Verbose bool
EnableProfiler bool
DisableRemoteRegistryProxy bool
NoAutoSkip bool
GithubAnnotations bool
}
Global flags on Flags instead as there are other things in the CLI that are being called + set by the subcommands so I thought it made since to declare them just once there and then pass them in.
Source Files
Click to show internal directories.
Click to hide internal directories.