cli

package

Go to main page

Versions in this module

v1

v1.13.1

Nov 5, 2025

v1.13.0

Oct 30, 2025

Changes in this version

type Config

+ GitClient GitClient

+ type GitClient interface

+ GeneratePatchFile func(destDir string) git.PatchFile

+ GetBranch func() string

+ GetCommit func() string

+ GetOriginUrl func() string

type InitiateRunConfig

+ GitBranch string

+ GitSha string

type LoginConfig

+ PollInterval time.Duration

type PushImageConfig

+ PollInterval time.Duration

v1.12.0

Oct 2, 2025

Changes in this version

type APIClient

+ ImagePushStatus func(pushID string) (api.ImagePushStatusResult, error)

+ StartImagePush func(cfg api.StartImagePushConfig) (api.StartImagePushResult, error)

type Config

+ StderrIsTTY bool

+ StdoutIsTTY bool

+ type PushImageConfig struct

+ DockerCLI dockercli.AuthConfigurator

+ JSON bool

+ OpenURL func(url string) error

+ References []reference.Named

+ TaskID string

+ Wait bool

+ func NewPushImageConfig(taskID string, references []string, json bool, wait bool, ...) (PushImageConfig, error)

+ type PushImageOutput struct

+ PushID string

+ RunURL string

+ Status string

type Service

+ func (s Service) PushImage(config PushImageConfig) error

type YAMLDoc

+ func (doc *YAMLDoc) AllTasksAreEmbeddedRuns() bool

v1.11.0

Aug 8, 2025

v1.10.3

Jul 16, 2025

v1.10.2

Jul 2, 2025

v1.10.1

Jun 27, 2025

v1.10.0

Jun 27, 2025

v1.9.1

Jun 25, 2025

v1.9.0

Jun 25, 2025

Changes in this version

type APIClient

+ GetPackageVersions func() (*api.PackageVersionsResult, error)

+ type PackageVersion struct

+ MajorVersion string

+ Name string

+ Original string

+ Version string

+ type ResolvePackagesConfig struct

+ Files []string

+ LatestVersionPicker func(versions api.PackageVersionsResult, rwxPackage string, _ string) (string, error)

+ RwxDirectory string

+ func (c ResolvePackagesConfig) PickLatestVersion(versions api.PackageVersionsResult, rwxPackage string) (string, error)

+ func (c ResolvePackagesConfig) Validate() error

+ type ResolvePackagesResult struct

+ ResolvedPackages map[string]string

+ func (r ResolvePackagesResult) HasChanges() bool

type Service

+ func (s Service) ResolvePackages(cfg ResolvePackagesConfig) (ResolvePackagesResult, error)

+ func (s Service) UpdatePackages(cfg UpdatePackagesConfig) error

+ type UpdatePackagesConfig struct

+ Files []string

+ ReplacementVersionPicker func(versions api.PackageVersionsResult, rwxPackage string, major string) (string, error)

+ RwxDirectory string

+ func (c UpdatePackagesConfig) Validate() error

v1.8.0

Jun 24, 2025

Changes in this version

+ const DefaultArch

+ var HandledError = errors.New("handled error")

+ func Map[T any, R any](input []T, transformer func(T) R) []R

+ func PickLatestMajorVersion(versions api.LeafVersionsResult, leaf string, _ string) (string, error)

+ func PickLatestMinorVersion(versions api.LeafVersionsResult, leaf string, major string) (string, error)

+ type APIClient interface

+ AcquireToken func(tokenUrl string) (*api.AcquireTokenResult, error)

+ GetDebugConnectionInfo func(debugKey string) (api.DebugConnectionInfo, error)

+ GetDispatch func(api.GetDispatchConfig) (*api.GetDispatchResult, error)

+ GetLeafVersions func() (*api.LeafVersionsResult, error)

+ InitiateDispatch func(api.InitiateDispatchConfig) (*api.InitiateDispatchResult, error)

+ InitiateRun func(api.InitiateRunConfig) (*api.InitiateRunResult, error)

+ Lint func(api.LintConfig) (*api.LintResult, error)

+ ObtainAuthCode func(api.ObtainAuthCodeConfig) (*api.ObtainAuthCodeResult, error)

+ ResolveBaseLayer func(api.ResolveBaseLayerConfig) (api.ResolveBaseLayerResult, error)

+ SetSecretsInVault func(api.SetSecretsInVaultConfig) (*api.SetSecretsInVaultResult, error)

+ Whoami func() (*api.WhoamiResult, error)

+ type BaseLayerRunFile struct

+ Error error

+ OriginalBase BaseLayerSpec

+ OriginalPath string

+ ResolvedBase BaseLayerSpec

+ Spec BaseLayerSpec

+ func (rf BaseLayerRunFile) HasChanges() bool

+ type BaseLayerSpec struct

+ Arch string

+ Os string

+ Tag string

+ func (b BaseLayerSpec) Equal(other BaseLayerSpec) bool

+ func (b BaseLayerSpec) Merge(other BaseLayerSpec) BaseLayerSpec

+ func (b BaseLayerSpec) TagVersion() *semver.Version

+ type Config struct

+ APIClient APIClient

+ SSHClient SSHClient

+ Stderr io.Writer

+ Stdout io.Writer

+ func (c Config) Validate() error

+ type DebugTaskConfig struct

+ DebugKey string

+ func (c DebugTaskConfig) Validate() error

+ type GetDispatchConfig struct

+ DispatchId string

+ type GetDispatchRun struct

+ RunId string

+ RunUrl string

+ type InitiateDispatchConfig struct

+ DispatchKey string

+ Json bool

+ Params map[string]string

+ Ref string

+ Title string

+ func (c InitiateDispatchConfig) Validate() error

+ type InitiateRunConfig struct

+ InitParameters map[string]string

+ Json bool

+ MintFilePath string

+ NoCache bool

+ RwxDirectory string

+ TargetedTasks []string

+ Title string

+ func (c InitiateRunConfig) Validate() error

+ type LeafVersion struct

+ MajorVersion string

+ Name string

+ Original string

+ Version string

+ type LintConfig struct

+ OutputFormat LintOutputFormat

+ RwxDirectory string

+ func NewLintConfig(rwxDir string, formatString string) (LintConfig, error)

+ func (c LintConfig) Validate() error

+ type LintOutputFormat int

+ const LintOutputMultiLine

+ const LintOutputNone

+ const LintOutputOneLine

+ type LoginConfig struct

+ AccessTokenBackend accesstoken.Backend

+ DeviceName string

+ OpenUrl func(url string) error

+ func (c LoginConfig) Validate() error

+ type MintYAMLFile struct

+ Doc *YAMLDoc

+ Entry RwxDirectoryEntry

+ type ResolveBaseConfig struct

+ Arch string

+ Files []string

+ Os string

+ RwxDirectory string

+ Tag string

+ func (c ResolveBaseConfig) Validate() error

+ type ResolveBaseResult struct

+ ErroredRunFiles []BaseLayerRunFile

+ UpdatedRunFiles []BaseLayerRunFile

+ func (r ResolveBaseResult) HasChanges() bool

+ type ResolveLeavesConfig struct

+ Files []string

+ LatestVersionPicker func(versions api.LeafVersionsResult, leaf string, _ string) (string, error)

+ RwxDirectory string

+ func (c ResolveLeavesConfig) PickLatestVersion(versions api.LeafVersionsResult, leaf string) (string, error)

+ func (c ResolveLeavesConfig) Validate() error

+ type ResolveLeavesResult struct

+ ResolvedLeaves map[string]string

+ func (r ResolveLeavesResult) HasChanges() bool

+ type RwxDirectoryEntry = api.RwxDirectoryEntry

+ type SSHClient interface

+ Close func() error

+ Connect func(addr string, cfg ssh.ClientConfig) error

+ InteractiveSession func() error

+ type Service struct

+ func NewService(cfg Config) (Service, error)

+ func (s Service) DebugTask(cfg DebugTaskConfig) error

+ func (s Service) GetDispatch(cfg GetDispatchConfig) ([]GetDispatchRun, error)

+ func (s Service) InitiateDispatch(cfg InitiateDispatchConfig) (*api.InitiateDispatchResult, error)

+ func (s Service) InitiateRun(cfg InitiateRunConfig) (*api.InitiateRunResult, error)

+ func (s Service) Lint(cfg LintConfig) (*api.LintResult, error)

+ func (s Service) Login(cfg LoginConfig) error

+ func (s Service) ResolveBase(cfg ResolveBaseConfig) (ResolveBaseResult, error)

+ func (s Service) ResolveLeaves(cfg ResolveLeavesConfig) (ResolveLeavesResult, error)

+ func (s Service) SetSecretsInVault(cfg SetSecretsInVaultConfig) error

+ func (s Service) UpdateBase(cfg UpdateBaseConfig) (ResolveBaseResult, error)

+ func (s Service) UpdateLeaves(cfg UpdateLeavesConfig) error

+ func (s Service) Whoami(cfg WhoamiConfig) error

+ type SetSecretsInVaultConfig struct

+ File string

+ Secrets []string

+ Vault string

+ func (c SetSecretsInVaultConfig) Validate() error

+ type TaskDefinition = api.TaskDefinition

+ type UpdateBaseConfig struct

+ Files []string

+ RwxDirectory string

+ func (c UpdateBaseConfig) Validate() error

+ type UpdateLeavesConfig struct

+ Files []string

+ ReplacementVersionPicker func(versions api.LeafVersionsResult, leaf string, major string) (string, error)

+ RwxDirectory string

+ func (c UpdateLeavesConfig) Validate() error

+ type WhoamiConfig struct

+ Json bool

+ func (c WhoamiConfig) Validate() error

+ type YAMLDoc struct

+ func ParseYAMLDoc(content string) (*YAMLDoc, error)

+ func ParseYAMLFile(path string) (*YAMLDoc, error)

+ func (doc *YAMLDoc) Bytes() []byte

+ func (doc *YAMLDoc) ForEachNode(yamlPath string, f func(node ast.Node) error) error

+ func (doc *YAMLDoc) HasBase() bool

+ func (doc *YAMLDoc) HasChanges() bool

+ func (doc *YAMLDoc) HasTasks() bool

+ func (doc *YAMLDoc) InsertBefore(beforeYamlPath string, value any) error

+ func (doc *YAMLDoc) IsListOfTasks() bool

+ func (doc *YAMLDoc) IsRunDefinition() bool

+ func (doc *YAMLDoc) MergeAtPath(yamlPath string, value any) error

+ func (doc *YAMLDoc) ReadStringAtPath(yamlPath string) (string, error)

+ func (doc *YAMLDoc) ReplaceAtPath(yamlPath string, replacement any) error

+ func (doc *YAMLDoc) SetAtPath(yamlPath string, value any) error

+ func (doc *YAMLDoc) String() string

+ func (doc *YAMLDoc) TryReadStringAtPath(yamlPath string) string

+ func (doc *YAMLDoc) WriteFile(path string) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL