commands

Documentation

Index

• func AddBuildpackRegistry(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func AddHelpFlag(cmd *cobra.Command, commandName string)
• func Build(logger logging.Logger, cfg config.Config, packClient PackClient) *cobra.Command
• func CompletionCommand(logger logging.Logger) *cobra.Command
• func CreateBuilder(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func CreateCancellableContext() context.Context
• func InspectBuilder(logger logging.Logger, cfg config.Config, inspector BuilderInspector, ...) *cobra.Command
• func InspectBuildpack(logger logging.Logger, cfg *config.Config, client PackClient) *cobra.Command
• func InspectImage(logger logging.Logger, cfg *config.Config, client PackClient) *cobra.Command
• func ListBuildpackRegistries(logger logging.Logger, cfg config.Config) *cobra.Command
• func ListTrustedBuilders(logger logging.Logger, cfg config.Config) *cobra.Command
• func PackageBuildpack(logger logging.Logger, cfg config.Config, client BuildpackPackager, ...) *cobra.Command
• func Rebase(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func RegisterBuildpack(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func RemoveRegistry(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func Report(logger logging.Logger, version string) *cobra.Command
• func SetDefaultBuilder(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func SetDefaultRegistry(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func SetRunImagesMirrors(logger logging.Logger, cfg config.Config) *cobra.Command
• func SuggestBuilders(logger logging.Logger, inspector BuilderInspector) *cobra.Command
• func SuggestStacks(logger logging.Logger) *cobra.Command
• func TrustBuilder(logger logging.Logger, cfg config.Config) *cobra.Command
• func UntrustBuilder(logger logging.Logger, cfg config.Config) *cobra.Command
• func Version(logger logging.Logger, version string) *cobra.Command
• func WriteSuggestedBuilder(logger logging.Logger, inspector BuilderInspector, builders []SuggestedBuilder)
• func YankBuildpack(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• type BuildFlags
• type BuilderInspector
• type BuildpackPackager
• type CompletionFlags
• type CreateBuilderFlags
• type InspectBuilderFlags
• type InspectBuildpackFlags
• type InspectImageFlags
• type PackClient
• type PackageBuildpackFlags
• type PackageConfigReader
• type RegisterBuildpackFlags
• type SuggestedBuilder
• type YankBuildpackFlags

Functions

func AddBuildpackRegistry

func AddBuildpackRegistry(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command

func AddHelpFlag

func AddHelpFlag(cmd *cobra.Command, commandName string)

func Build

func Build(logger logging.Logger, cfg config.Config, packClient PackClient) *cobra.Command

Build an image from source code

func CompletionCommand

func CompletionCommand(logger logging.Logger) *cobra.Command

func CreateBuilder

func CreateBuilder(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command

CreateBuilder creates a builder image, based on a builder config

func CreateCancellableContext

func CreateCancellableContext() context.Context

func InspectBuilder

func InspectBuilder(
	logger logging.Logger,
	cfg config.Config,
	inspector BuilderInspector,
	writerFactory writer.BuilderWriterFactory,
) *cobra.Command

func InspectBuildpack

func InspectBuildpack(logger logging.Logger, cfg *config.Config, client PackClient) *cobra.Command

func InspectImage

func InspectImage(logger logging.Logger, cfg *config.Config, client PackClient) *cobra.Command

func ListBuildpackRegistries

func ListBuildpackRegistries(logger logging.Logger, cfg config.Config) *cobra.Command

func ListTrustedBuilders

func ListTrustedBuilders(logger logging.Logger, cfg config.Config) *cobra.Command

func PackageBuildpack

func PackageBuildpack(logger logging.Logger, cfg config.Config, client BuildpackPackager, packageConfigReader PackageConfigReader) *cobra.Command

PackageBuildpack packages (a) buildpack(s) into OCI format, based on a package config

func Rebase

func Rebase(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command

func RegisterBuildpack

func RegisterBuildpack(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command

func RemoveRegistry

func RemoveRegistry(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command

func Report

func Report(logger logging.Logger, version string) *cobra.Command

func SetDefaultBuilder

func SetDefaultBuilder(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command

func SetDefaultRegistry

func SetDefaultRegistry(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command

func SetRunImagesMirrors

func SetRunImagesMirrors(logger logging.Logger, cfg config.Config) *cobra.Command

SetRunImagesMirrors sets run image mirros for a given run image

func SuggestBuilders

func SuggestBuilders(logger logging.Logger, inspector BuilderInspector) *cobra.Command

func SuggestStacks

func SuggestStacks(logger logging.Logger) *cobra.Command

func TrustBuilder

func TrustBuilder(logger logging.Logger, cfg config.Config) *cobra.Command

func UntrustBuilder

func UntrustBuilder(logger logging.Logger, cfg config.Config) *cobra.Command

func Version

func Version(logger logging.Logger, version string) *cobra.Command

Version shows the current pack version

func WriteSuggestedBuilder

func WriteSuggestedBuilder(logger logging.Logger, inspector BuilderInspector, builders []SuggestedBuilder)

func YankBuildpack

func YankBuildpack(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command

Types

type BuildFlags

type BuildFlags struct {
	Publish            bool
	ClearCache         bool
	TrustBuilder       bool
	AppPath            string
	Builder            string
	Registry           string
	RunImage           string
	Policy             string
	Network            string
	DescriptorPath     string
	DefaultProcessType string
	Env                []string
	EnvFiles           []string
	Buildpacks         []string
	Volumes            []string
}

type BuilderInspector

type BuilderInspector interface {
	InspectBuilder(name string, daemon bool, modifiers ...pack.BuilderInspectionModifier) (*pack.BuilderInfo, error)
}

type BuildpackPackager

type BuildpackPackager interface {
	PackageBuildpack(ctx context.Context, options pack.PackageBuildpackOptions) error
}

BuildpackPackager packages buildpacks

type CompletionFlags

type CompletionFlags struct {
	Shell string
}

type CreateBuilderFlags

type CreateBuilderFlags struct {
	BuilderTomlPath string
	Publish         bool
	Registry        string
	Policy          string
}

CreateBuilderFlags define flags provided to the CreateBuilder command

type InspectBuilderFlags

type InspectBuilderFlags struct {
	Depth        int
	OutputFormat string
}

type InspectBuildpackFlags

type InspectBuildpackFlags struct {
	Depth    int
	Registry string
	Verbose  bool
}

type InspectImageFlags

type InspectImageFlags struct {
	BOM bool
}

type PackClient

type PackClient interface {
	InspectBuilder(string, bool, ...pack.BuilderInspectionModifier) (*pack.BuilderInfo, error)
	InspectImage(string, bool) (*pack.ImageInfo, error)
	Rebase(context.Context, pack.RebaseOptions) error
	CreateBuilder(context.Context, pack.CreateBuilderOptions) error
	PackageBuildpack(ctx context.Context, opts pack.PackageBuildpackOptions) error
	Build(context.Context, pack.BuildOptions) error
	RegisterBuildpack(context.Context, pack.RegisterBuildpackOptions) error
	YankBuildpack(pack.YankBuildpackOptions) error
	InspectBuildpack(pack.InspectBuildpackOptions) (*pack.BuildpackInfo, error)
}

type PackageBuildpackFlags

type PackageBuildpackFlags struct {
	PackageTomlPath string
	Format          string
	Publish         bool
	Policy          string
}

PackageBuildpackFlags define flags provided to the PackageBuildpack command

type PackageConfigReader

type PackageConfigReader interface {
	Read(path string) (pubbldpkg.Config, error)
}

PackageConfigReader reads PackageBuildpack configs

type RegisterBuildpackFlags

type RegisterBuildpackFlags struct {
	BuildpackRegistry string
}

type SuggestedBuilder

type SuggestedBuilder struct {
	Vendor             string
	Image              string
	DefaultDescription string
}

type YankBuildpackFlags

type YankBuildpackFlags struct {
	BuildpackRegistry string
	Undo              bool
}