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 BuilderCreate(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func BuilderInspect(logger logging.Logger, cfg config.Config, inspector BuilderInspector, ...) *cobra.Command
• func BuilderSuggest(logger logging.Logger, inspector BuilderInspector) *cobra.Command
• func BuildpackInspect(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func BuildpackNew(logger logging.Logger, client BuildpackCreator) *cobra.Command
• func BuildpackPackage(logger logging.Logger, cfg config.Config, client BuildpackPackager, ...) *cobra.Command
• func BuildpackPull(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func BuildpackRegister(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func BuildpackYank(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func CompletionCommand(logger logging.Logger, packHome string) *cobra.Command
• func ConfigDefaultBuilder(logger logging.Logger, cfg config.Config, cfgPath string, client PackClient) *cobra.Command
• func ConfigExperimental(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func ConfigLifecycleImage(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func ConfigPullPolicy(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func ConfigRegistries(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func ConfigRegistriesDefault(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func ConfigRegistryMirrors(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func ConfigRunImagesMirrors(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func ConfigTrustedBuilder(logger logging.Logger, cfg config.Config, cfgPath string) *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, writerFactory InspectImageWriterFactory, ...) *cobra.Command
• func ListBuildpackRegistries(logger logging.Logger, cfg config.Config) *cobra.Command
• func ListTrustedBuilders(logger logging.Logger, cfg config.Config) *cobra.Command
• func NewBuilderCommand(logger logging.Logger, cfg config.Config, client PackClient) *cobra.Command
• func NewBuildpackCommand(logger logging.Logger, cfg config.Config, client PackClient, ...) *cobra.Command
• func NewConfigCommand(logger logging.Logger, cfg config.Config, cfgPath string, client PackClient) *cobra.Command
• func NewStackCommand(logger logging.Logger) *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, cfgPath string) *cobra.Command
• func SetDefaultBuilder(logger logging.Logger, cfg config.Config, cfgPath string, client PackClient) *cobra.Command
• func SetDefaultRegistry(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func SetRunImagesMirrors(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func Suggest(log logging.Logger)
• func SuggestBuilders(logger logging.Logger, inspector BuilderInspector) *cobra.Command
• func SuggestStacks(logger logging.Logger) *cobra.Command
• func TrustBuilder(logger logging.Logger, cfg config.Config, cfgPath string) *cobra.Command
• func UntrustBuilder(logger logging.Logger, cfg config.Config, cfgPath string) *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 BuilderCreateFlags
• type BuilderInspectFlags
• type BuilderInspector
• type BuildpackCreator
• type BuildpackInspectFlags
• type BuildpackNewFlags
• type BuildpackPackageFlags
• type BuildpackPackager
• type BuildpackPullFlags
• type BuildpackRegisterFlags
• type BuildpackYankFlags
• type CompletionFlags
• type InspectImageFlags
• type InspectImageWriterFactory
• type PackClient
• type PackageConfigReader
• type SuggestedBuilder

Functions

func AddBuildpackRegistry

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

Deprecated: Use config registries add instead

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 BuilderCreate

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

CreateBuilder creates a builder image, based on a builder config

func BuilderInspect

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

func BuilderSuggest

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

func BuildpackInspect

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

func BuildpackNew

func BuildpackNew(logger logging.Logger, client BuildpackCreator) *cobra.Command

BuildpackNew generates the scaffolding of a buildpack

func BuildpackPackage

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

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

func BuildpackPull

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

BuildpackPull pulls a buildpack and stores it locally

func BuildpackRegister

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

func BuildpackYank

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

func CompletionCommand

func CompletionCommand(logger logging.Logger, packHome string) *cobra.Command

func ConfigDefaultBuilder

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

func ConfigExperimental

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

func ConfigLifecycleImage

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

func ConfigPullPolicy

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

func ConfigRegistries

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

func ConfigRegistriesDefault

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

func ConfigRegistryMirrors

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

func ConfigRunImagesMirrors

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

func ConfigTrustedBuilder

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

func CreateBuilder

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

Deprecated: Use 'builder create' instead. 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

Deprecated: Use builder inspect instead.

func InspectBuildpack

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

Deprecated: Use buildpack inspect instead.

func InspectImage

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

func ListBuildpackRegistries

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

Deprecated: Use config registries list instead

func ListTrustedBuilders

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

Deprecated: Use `config trusted-builders list` instead

func NewBuilderCommand

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

func NewBuildpackCommand

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

func NewConfigCommand

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

func NewStackCommand

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

func PackageBuildpack

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

Deprecated: use BuildpackPackage instead 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

Deprecated: Use BuildpackRegister instead

func RemoveRegistry

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

Deprecated: Use config registries remove instead

func Report

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

func SetDefaultBuilder

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

Deprecated: Use `pack config default-builder`

func SetDefaultRegistry

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

Deprecated: Use `pack config registries default` instead

func SetRunImagesMirrors

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

Deprecated: Use `pack config run-image-mirrors add` instead SetRunImagesMirrors sets run image mirros for a given run image

func Suggest

func Suggest(log logging.Logger)

func SuggestBuilders

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

Deprecated: Use `builder suggest` instead.

func SuggestStacks

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

Deprecated: Use `stack suggest` instead

func TrustBuilder

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

Deprecated: Use `config trusted-builders add` instead

func UntrustBuilder

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

Deprecated: Use `config trusted-builders remove` instead

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

Deprecated: Use yank instead

Types

type BuildFlags

type BuildFlags struct {
	Publish            bool
	ClearCache         bool
	TrustBuilder       bool
	DockerHost         string
	CacheImage         string
	AppPath            string
	Builder            string
	Registry           string
	RunImage           string
	Policy             string
	Network            string
	DescriptorPath     string
	DefaultProcessType string
	LifecycleImage     string
	Env                []string
	EnvFiles           []string
	Buildpacks         []string
	Volumes            []string
	AdditionalTags     []string
	Workspace          string
	GID                int
}

type BuilderCreateFlags

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

BuilderCreateFlags define flags provided to the CreateBuilder command

type BuilderInspectFlags

type BuilderInspectFlags struct {
	Depth        int
	OutputFormat string
}

type BuilderInspector

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

type BuildpackCreator

type BuildpackCreator interface {
	NewBuildpack(ctx context.Context, options pack.NewBuildpackOptions) error
}

BuildpackCreator creates buildpacks

type BuildpackInspectFlags

type BuildpackInspectFlags struct {
	Depth    int
	Registry string
	Verbose  bool
}

type BuildpackNewFlags

type BuildpackNewFlags struct {
	API     string
	Path    string
	Stacks  []string
	Version string
}

BuildpackNewFlags define flags provided to the BuildpackNew command

type BuildpackPackageFlags

type BuildpackPackageFlags struct {
	PackageTomlPath   string
	Format            string
	Publish           bool
	Policy            string
	BuildpackRegistry string
	Path              string
}

BuildpackPackageFlags define flags provided to the BuildpackPackage command

type BuildpackPackager

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

BuildpackPackager packages buildpacks

type BuildpackPullFlags

type BuildpackPullFlags struct {
	// BuildpackRegistry is the name of the buildpack registry to use to search for
	BuildpackRegistry string
}

BuildpackPullFlags consist of flags applicable to the `buildpack pull` command

type BuildpackRegisterFlags

type BuildpackRegisterFlags struct {
	BuildpackRegistry string
}

type BuildpackYankFlags

type BuildpackYankFlags struct {
	BuildpackRegistry string
	Undo              bool
}

type CompletionFlags

type CompletionFlags struct {
	Shell string
}

type InspectImageFlags

type InspectImageFlags struct {
	BOM          bool
	OutputFormat string
}

type InspectImageWriterFactory

type InspectImageWriterFactory interface {
	Writer(kind string, BOM bool) (writer.InspectImageWriter, error)
}

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
	NewBuildpack(context.Context, pack.NewBuildpackOptions) 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)
	PullBuildpack(context.Context, pack.PullBuildpackOptions) error
}

type PackageConfigReader

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

PackageConfigReader reads BuildpackPackage configs

type SuggestedBuilder

type SuggestedBuilder struct {
	Vendor             string
	Image              string
	DefaultDescription string
}