mod

Documentation

Index

• Constants
• func NewCmdAdd(io genericiooptions.IOStreams) *cobra.Command
• func NewCmdInit() *cobra.Command
• func NewCmdList(io genericiooptions.IOStreams) *cobra.Command
• func NewCmdMod(streams genericiooptions.IOStreams) *cobra.Command
• func NewCmdPush(ioStreams genericiooptions.IOStreams) *cobra.Command
• type AddFlag
• type AddOptions
  • func (o *AddOptions) Run() error
• type InitOptions
  • func (o *InitOptions) Run() error
  • func (o *InitOptions) Validate(args []string) error
• type ListFlag
• type ListOption
  • func (o *ListOption) Run() error
• type PushModFlags
  • func NewPushModFlags(ioStreams genericiooptions.IOStreams) *PushModFlags
  • func (flags *PushModFlags) AddFlags(cmd *cobra.Command)
  • func (flags *PushModFlags) ToOptions(args []string, ioStreams genericiooptions.IOStreams) (*PushModOptions, error)
• type PushModOptions
  • func (o *PushModOptions) Run() error
  • func (o *PushModOptions) Validate() error

Constants

const LatestVersion = "latest"

LatestVersion is the tag name that denotes the latest stable version of a module.

Functions

func NewCmdAdd

func NewCmdAdd(io genericiooptions.IOStreams) *cobra.Command

func NewCmdInit

func NewCmdInit() *cobra.Command

NewCmdInit returns an initialized Command instance for the 'mod init' sub command

func NewCmdList

func NewCmdList(io genericiooptions.IOStreams) *cobra.Command

func NewCmdMod

func NewCmdMod(streams genericiooptions.IOStreams) *cobra.Command

NewCmdMod returns an initialized Command instance for 'mod' sub command

func NewCmdPush

func NewCmdPush(ioStreams genericiooptions.IOStreams) *cobra.Command

NewCmdPush returns an initialized Command instance for the 'mod push' sub command.

Types

type AddFlag

type AddFlag struct {
	meta.MetaFlags
}

type AddOptions

type AddOptions struct {
	meta.MetaOptions
	// ModuleName referenced the module name to be added to the kcl.mod file.
	ModuleName string
	// IOStreams referenced the target IOStreams for this invocation.
	IO genericiooptions.IOStreams
}

func (*AddOptions) Run

func (o *AddOptions) Run() error

type InitOptions

type InitOptions struct {
	Name        string
	Path        string
	TemplateURL string
}

func (*InitOptions) Run

func (o *InitOptions) Run() error

func (*InitOptions) Validate

func (o *InitOptions) Validate(args []string) error

type ListFlag

type ListFlag struct {
	meta.MetaFlags
}

type ListOption

type ListOption struct {
	// Workspace referenced the workspace for this CLI invocation.
	Workspace *v1.Workspace
	// StorageBackend referenced the target storage backend for this CLI invocation.
	StorageBackend backend.Backend
	// IOStreams referenced the target IOStreams for this CLI invocation.
	IO genericiooptions.IOStreams
}

func (*ListOption) Run

func (o *ListOption) Run() error

type PushModFlags

type PushModFlags struct {
	Latest           bool
	OSArch           string
	Annotations      []string
	Credentials      string
	Sign             string
	CosignKey        string
	InsecureRegistry bool

	genericiooptions.IOStreams
}

PushModFlags directly reflect the information that CLI is gathering via flags. They will be converted to PushModOptions, which reflect the runtime requirements for the command.

This structure reduces the transformation to wiring and makes the logic itself easy to unit test.

func NewPushModFlags

func NewPushModFlags(ioStreams genericiooptions.IOStreams) *PushModFlags

NewPushModFlags returns a default PushModFlags.

func (*PushModFlags) AddFlags

func (flags *PushModFlags) AddFlags(cmd *cobra.Command)

AddFlags registers flags for a cli.

func (*PushModFlags) ToOptions

func (flags *PushModFlags) ToOptions(args []string, ioStreams genericiooptions.IOStreams) (*PushModOptions, error)

ToOptions converts from CLI inputs to runtime inputs.

type PushModOptions

type PushModOptions struct {
	ModulePath string
	OCIUrl     string
	Latest     bool
	OSArch     string
	Name       string
	Version    string
	Sign       string
	CosignKey  string

	Client   *ociclient.Client
	Metadata metadata.Metadata

	genericiooptions.IOStreams
}

PushModOptions is a set of options that allows you to push module. This is the object reflects the runtime needs of a `mod push` command, making the logic itself easy to unit test.

func (*PushModOptions) Run

func (o *PushModOptions) Run() error

Run executes the `mod push` command.

func (*PushModOptions) Validate

func (o *PushModOptions) Validate() error

Validate verifies if PushModOptions are valid and without conflicts.