genFigSpec

README

Fig // Cobra CLI

This Go package is Fig's integration with popular CLI framework Cobra.

See Fig's docs for how to integrate: https://fig.io/docs/guides/autocomplete-for-teams/cobra

Contributors

This integration was built by Ethan Orlander. Please see his repo for the original docs, git history, and additional customization information: https://github.com/EthanOrlander/genFigSpec.

Documentation

Index

• func CreateCompletionSpecCommand(options ...Opts) *cobra.Command
• func NewCmdGenFigSpec(options ...Opts) *cobra.Command
• type Arg
  • func (arg *Arg) ToTypescript() string
• type Args
  • func (args *Args) ToTypescript() string
• type BaseSuggestion
• type Names
  • func (names *Names) ToTypescript() string
• type Option
  • func (option *Option) ToTypescript() string
• type Options
  • func (options *Options) ToTypescript() string
• type Opts
• type Spec
  • func GenerateCompletionSpec(root *cobra.Command) Spec
  • func MakeFigSpec(root *cobra.Command) Spec
  • func (spec *Spec) ToTypescript() string
• type Subcommand
  • func (subcommand *Subcommand) ToTypescript() string
• type Subcommands
  • func (subcommands *Subcommands) ToTypescript() string
• type Suggestion
• type SuggestionType
• type Template

Functions

func CreateCompletionSpecCommand

func CreateCompletionSpecCommand(options ...Opts) *cobra.Command

func NewCmdGenFigSpec

func NewCmdGenFigSpec(options ...Opts) *cobra.Command

Deprecated: this function has been renamed to `CreateCompletionSpecCommand` and may not be available in future releases

Types

type Arg

type Arg struct {
	// contains filtered or unexported fields
}

func (*Arg) ToTypescript

func (arg *Arg) ToTypescript() string

type Args

type Args []Arg

func (*Args) ToTypescript

func (args *Args) ToTypescript() string

type BaseSuggestion

type BaseSuggestion struct {
	// contains filtered or unexported fields
}

type Names

type Names []string

func (*Names) ToTypescript

func (names *Names) ToTypescript() string

type Option

type Option struct {
	*BaseSuggestion
	// contains filtered or unexported fields
}

func (*Option) ToTypescript

func (option *Option) ToTypescript() string

type Options

type Options []Option

func (*Options) ToTypescript

func (options *Options) ToTypescript() string

type Opts

type Opts struct {
	Use     string
	Short   string
	Visible bool
	Long    string
	// contains filtered or unexported fields
}

type Spec

type Spec struct {
	*Subcommand
	// contains filtered or unexported fields
}

func GenerateCompletionSpec

func GenerateCompletionSpec(root *cobra.Command) Spec

func MakeFigSpec

func MakeFigSpec(root *cobra.Command) Spec

Deprecated: this function has been renamed to `GenerateCompletionSpec` and may not be available in future releases

func (*Spec) ToTypescript

func (spec *Spec) ToTypescript() string

type Subcommand

type Subcommand struct {
	*BaseSuggestion
	// contains filtered or unexported fields
}

func (*Subcommand) ToTypescript

func (subcommand *Subcommand) ToTypescript() string

type Subcommands

type Subcommands []Subcommand

func (*Subcommands) ToTypescript

func (subcommands *Subcommands) ToTypescript() string

type Suggestion

type Suggestion struct {
	*BaseSuggestion
	// contains filtered or unexported fields
}

type SuggestionType

type SuggestionType int

const (
	FOLDER SuggestionType = iota
	FILE
	ARG
	SUBCOMMAND
	OPTION
	SPECIAL
	SHORTCUT
)

type Template

type Template int

const (
	FOLDERS Template = iota
	FILEPATHS
)