Documentation
¶
Index ¶
- Variables
- func Execute()
- func NewCacheCmd(streams cli.IOStreams) *cobra.Command
- func NewCompletionCmd(streams cli.IOStreams) *cobra.Command
- func NewConfigCmd(streams cli.IOStreams) *cobra.Command
- func NewGitignoreCmd(streams cli.IOStreams) *cobra.Command
- func NewInitCmd(streams cli.IOStreams) *cobra.Command
- func NewLicenseCmd(streams cli.IOStreams) *cobra.Command
- func NewProjectCmd(streams cli.IOStreams) *cobra.Command
- func NewRepositoryCmd(streams cli.IOStreams) *cobra.Command
- func NewRootCmd(streams cli.IOStreams) *cobra.Command
- func NewSkeletonCmd(streams cli.IOStreams) *cobra.Command
- func NewVersionCmd(streams cli.IOStreams) *cobra.Command
- type InitOptions
- type VersionOptions
Constants ¶
This section is empty.
Variables ¶
var ( // ErrIllegalVersionFlagCombination is returned if mutual exclusive version // format flags are set. ErrIllegalVersionFlagCombination = errors.New("--short and --output can't be used together") )
Functions ¶
func NewCacheCmd ¶
NewCacheCmd creates a command which provides subcommands for interacting with the kickoff cache.
func NewCompletionCmd ¶
NewCompletionCmd creates a new command which can set up shell completion.
func NewConfigCmd ¶
NewConfigCmd creates a new command which provides subcommands for manipulating and inspecting the kickoff config.
func NewGitignoreCmd ¶
NewGitignoreCmd creates a new command which provides subcommands for inspecting gitignore templates provided by gitignore.io.
func NewInitCmd ¶
NewInitCmd creates a new command which lets users interactively initialize the kickoff configuration.
func NewLicenseCmd ¶
NewLicenseCmd creates a new command which provides subcommands for inspecting open source licenses provided by the GitHub Licenses API.
func NewProjectCmd ¶
NewProjectCmd creates a new command which provides subcommands for working with projects.
func NewRepositoryCmd ¶
NewRepositoryCmd creates a new command which provides subcommands for managing, creating and inspecting skeleton repositories.
func NewRootCmd ¶
NewRootCmd creates the root command for kickoff.
func NewSkeletonCmd ¶
NewSkeletonCmd creates a new command which provides subcommands for creating and inspecting project skeletons.
Types ¶
type InitOptions ¶
type InitOptions struct {
cli.IOStreams
cmdutil.ConfigFlags
cmdutil.TimeoutFlag
GitignoreClient *gitignore.Client
LicenseClient *license.Client
}
InitOptions holds the options for the init command.
func (*InitOptions) Complete ¶
func (o *InitOptions) Complete() (err error)
Complete completes the command options.
func (*InitOptions) Run ¶
func (o *InitOptions) Run() error
Run runs the interactive configuration of kickoff.
type VersionOptions ¶
type VersionOptions struct {
cli.IOStreams
cmdutil.OutputFlag
Short bool
}
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.
func (*VersionOptions) Validate ¶
func (o *VersionOptions) Validate() error
Validate validates the options before executing the command.