cmd

Documentation

Index

• func Execute()
• func NewCacheCmd(streams cli.IOStreams) *cobra.Command
• func NewCompletionCmd(streams cli.IOStreams) *cobra.Command
• func NewConfigCmd(f *cmdutil.Factory) *cobra.Command
• func NewGitignoreCmd(f *cmdutil.Factory) *cobra.Command
• func NewInitCmd(f *cmdutil.Factory) *cobra.Command
• func NewLicenseCmd(f *cmdutil.Factory) *cobra.Command
• func NewProjectCmd(f *cmdutil.Factory) *cobra.Command
• func NewRepositoryCmd(f *cmdutil.Factory) *cobra.Command
• func NewRootCmd(f *cmdutil.Factory) *cobra.Command
• func NewSkeletonCmd(f *cmdutil.Factory) *cobra.Command
• func NewVersionCmd(streams cli.IOStreams) *cobra.Command
• type InitOptions
  • func (o *InitOptions) Run() error
• type VersionOptions
  • func (o *VersionOptions) Run() error

Functions

func Execute

func Execute()

func NewCacheCmd

func NewCacheCmd(streams cli.IOStreams) *cobra.Command

NewCacheCmd creates a command which provides subcommands for interacting with the kickoff cache.

func NewCompletionCmd

func NewCompletionCmd(streams cli.IOStreams) *cobra.Command

NewCompletionCmd creates a new command which can set up shell completion.

func NewConfigCmd

func NewConfigCmd(f *cmdutil.Factory) *cobra.Command

NewConfigCmd creates a new command which provides subcommands for manipulating and inspecting the kickoff config.

func NewGitignoreCmd

func NewGitignoreCmd(f *cmdutil.Factory) *cobra.Command

NewGitignoreCmd creates a new command which provides subcommands for inspecting gitignore templates available via the GitHub Gitignores API.

func NewInitCmd

func NewInitCmd(f *cmdutil.Factory) *cobra.Command

NewInitCmd creates a new command which lets users interactively initialize the kickoff configuration.

func NewLicenseCmd

func NewLicenseCmd(f *cmdutil.Factory) *cobra.Command

NewLicenseCmd creates a new command which provides subcommands for inspecting open source licenses provided by the GitHub Licenses API.

func NewProjectCmd

func NewProjectCmd(f *cmdutil.Factory) *cobra.Command

NewProjectCmd creates a new command which provides subcommands for working with projects.

func NewRepositoryCmd

func NewRepositoryCmd(f *cmdutil.Factory) *cobra.Command

NewRepositoryCmd creates a new command which provides subcommands for managing, creating and inspecting skeleton repositories.

func NewRootCmd

func NewRootCmd(f *cmdutil.Factory) *cobra.Command

NewRootCmd creates the root command for kickoff.

func NewSkeletonCmd

func NewSkeletonCmd(f *cmdutil.Factory) *cobra.Command

NewSkeletonCmd creates a new command which provides subcommands for creating and inspecting project skeletons.

func NewVersionCmd

func NewVersionCmd(streams cli.IOStreams) *cobra.Command

NewVersionCmd creates a command which can print the kickoff version.

Types

type InitOptions

type InitOptions struct {
	cli.IOStreams

	Config     func() (*kickoff.Config, error)
	HTTPClient func() *http.Client
	Prompt     prompt.Prompt

	ConfigPath string
}

InitOptions holds the options for the init command.

func (*InitOptions) Run

func (o *InitOptions) Run() error

Run runs the interactive configuration of kickoff.

type VersionOptions

type VersionOptions struct {
	cli.IOStreams

	Output string
}

VersionOptions holds the options for the version command.

func (*VersionOptions) Run

func (o *VersionOptions) Run() error

Run prints the version in the provided output format.