cli

Documentation

Index

• Variables
• func AGPL() []*cobra.Command
• func Core() []*cobra.Command
• func CreateClient(cmd *cobra.Command) (*codersdk.Client, error)
• func CurrentOrganization(cmd *cobra.Command, client *codersdk.Client) (codersdk.Organization, error)
• func EnsureExperimental(cmd *cobra.Command, name string) error
• func ExperimentalEnabled(cmd *cobra.Command) bool
• func FormatCobraError(err error, cmd *cobra.Command) string
• func Root(subcommands []*cobra.Command) *cobra.Command
• func Server(vip *viper.Viper, ...) *cobra.Command

Variables

var (
	Caret = cliui.Styles.Prompt.String()
)

Functions

func AGPL

func AGPL() []*cobra.Command

func Core

func Core() []*cobra.Command

func CreateClient

func CreateClient(cmd *cobra.Command) (*codersdk.Client, error)

CreateClient returns a new client from the command context. It reads from global configuration files if flags are not set.

func CurrentOrganization

func CurrentOrganization(cmd *cobra.Command, client *codersdk.Client) (codersdk.Organization, error)

CurrentOrganization returns the currently active organization for the authenticated user.

func EnsureExperimental

func EnsureExperimental(cmd *cobra.Command, name string) error

EnsureExperimental will ensure that the experimental feature flag is set if the given flag is set.

func ExperimentalEnabled

func ExperimentalEnabled(cmd *cobra.Command) bool

ExperimentalEnabled returns if the experimental feature flag is enabled.

func FormatCobraError

func FormatCobraError(err error, cmd *cobra.Command) string

FormatCobraError colorizes and adds "--help" docs to cobra commands.

func Root

func Root(subcommands []*cobra.Command) *cobra.Command

func Server

func Server(vip *viper.Viper, newAPI func(context.Context, *coderd.Options) (*coderd.API, io.Closer, error)) *cobra.Command

nolint:gocyclo