commands

Documentation

Index

• Constants
• Variables
• func RequestPermission() error
• func RunSearch(sdkName string, availableArgs []string) error

Constants

const CategoryPlugin = "Plugin"

const CategorySDK = "SDK"

const SelfUpgradeName = "upgrade"

Variables

var Activate = &cli.Command{
	Name:     "activate",
	Hidden:   true,
	Action:   activateCmd,
	Category: CategorySDK,
}

var Add = &cli.Command{
	Name:  "add",
	Usage: "Add a plugin or plugins",
	Flags: []cli.Flag{
		&cli.StringFlag{
			Name:    "source",
			Aliases: []string{"s"},
			Usage:   "plugin source",
		},
		&cli.StringFlag{
			Name:  "alias",
			Usage: "plugin alias",
		},
	},
	Action:   addCmd,
	Category: CategoryPlugin,
}

var Available = &cli.Command{
	Name:     "available",
	Usage:    "Show all available plugins",
	Action:   availableCmd,
	Category: CategoryPlugin,
}

var Cd = &cli.Command{
	Name:  "cd",
	Usage: "Launch a shell in the VFOX_HOME or SDK directory",
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:    "plugin",
			Aliases: []string{"p"},
			Usage:   "Launch a shell in the plugin directory",
		},
	},
	Action: cdCmd,
}

var Config = &cli.Command{
	Name:  "config",
	Usage: "Setup, view config",
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:    "list",
			Aliases: []string{"l"},
			Usage:   "list all config",
		},
		&cli.BoolFlag{
			Name:    "unset",
			Aliases: []string{"un"},
			Usage:   "remove a config",
		},
	},
	Action: configCmd,
}

var Current = &cli.Command{
	Name:      "current",
	Aliases:   []string{"c"},
	Usage:     "Show current version of the target SDK",
	UsageText: "Show current version of all SDK's if no parameters are passed",
	Action:    currentCmd,
	Category:  CategorySDK,
}

var Env = &cli.Command{
	Name: "env",
	Flags: []cli.Flag{
		&cli.StringFlag{
			Name:    "shell",
			Aliases: []string{"s"},
			Usage:   "shell name",
		},
		&cli.BoolFlag{
			Name:    "cleanup",
			Aliases: []string{"c"},
			Usage:   "cleanup old temp files",
		},
		&cli.BoolFlag{
			Name:    "json",
			Aliases: []string{"j"},
			Usage:   "output json format",
		},
	},
	Action:   envCmd,
	Category: CategorySDK,
}

var Info = &cli.Command{
	Name:     "info",
	Usage:    "Show plugin info",
	Action:   infoCmd,
	Category: CategoryPlugin,
}

var Install = &cli.Command{
	Name:    "install",
	Aliases: []string{"i"},
	Usage:   "Install a version of the target SDK",
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:    "all",
			Aliases: []string{"a"},
			Usage:   "Install all SDK versions recorded in .tool-versions",
		},
	},
	Action:   installCmd,
	Category: CategorySDK,
}

var List = &cli.Command{
	Name:     "list",
	Aliases:  []string{"ls"},
	Usage:    "List all versions of the target SDK",
	Action:   listCmd,
	Category: CategorySDK,
}

var Remove = &cli.Command{
	Name:     "remove",
	Usage:    "Remove a plugin",
	Action:   removeCmd,
	Category: CategoryPlugin,
}

var Search = &cli.Command{
	Name:     "search",
	Usage:    "Search a version of the target SDK",
	Action:   searchCmd,
	Category: CategorySDK,
}

var Uninstall = &cli.Command{
	Name:     "uninstall",
	Aliases:  []string{"un"},
	Usage:    "Uninstall a version of the target SDK",
	Action:   uninstallCmd,
	Category: CategorySDK,
}

var Update = &cli.Command{
	Name:  "update",
	Usage: "Update specified plugin, use --all/-a to update all installed plugins",
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:    allFlag,
			Aliases: []string{"a"},
			Usage:   "all plugins flag",
		},
	},
	Action:   updateCmd,
	Category: CategoryPlugin,
}

var Upgrade = &cli.Command{
	Name:   SelfUpgradeName,
	Usage:  "upgrade vfox to the latest version",
	Action: upgradeCmd,
}

var Use = &cli.Command{
	Name:    "use",
	Aliases: []string{"u"},
	Usage:   "Use a version of the target SDK",
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:    "global",
			Aliases: []string{"g"},
			Usage:   "Used with the global environment",
		},
		&cli.BoolFlag{
			Name:    "project",
			Aliases: []string{"p"},
			Usage:   "Used with the current directory",
		},
		&cli.BoolFlag{
			Name:    "session",
			Aliases: []string{"s"},
			Usage:   "Used with the current shell session",
		},
	},
	Action:   useCmd,
	Category: CategorySDK,
}

Functions

func RequestPermission

func RequestPermission() error

func RunSearch

func RunSearch(sdkName string, availableArgs []string) error