cli

Documentation

Index

• Variables
• func AGPL() []*cobra.Command
• func ContextWithLogger(ctx context.Context, l slog.Logger) context.Context
• func Core() []*cobra.Command
• func CreateClient(cmd *cobra.Command) (*codersdk.Client, error)
• func CurrentOrganization(cmd *cobra.Command, client *codersdk.Client) (codersdk.Organization, error)
• func FormatCobraError(err error, cmd *cobra.Command) string
• func LoggerFromContext(ctx context.Context) (slog.Logger, bool)
• func ParseProvisionerTags(rawTags []string) (map[string]string, error)
• func ReadGitAuthProvidersFromEnv(environ []string) ([]codersdk.GitAuthConfig, error)
• func Root(subcommands []*cobra.Command) *cobra.Command
• func Server(newAPI func(context.Context, *coderd.Options) (*coderd.API, io.Closer, error)) *cobra.Command

Variables

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

var InterruptSignals = []os.Signal{
	os.Interrupt,
	syscall.SIGTERM,
	syscall.SIGHUP,
}

Functions

func AGPL

func AGPL() []*cobra.Command

func ContextWithLogger

func ContextWithLogger(ctx context.Context, l slog.Logger) context.Context

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 FormatCobraError

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

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

func LoggerFromContext

func LoggerFromContext(ctx context.Context) (slog.Logger, bool)

func ParseProvisionerTags

func ParseProvisionerTags(rawTags []string) (map[string]string, error)

func ReadGitAuthProvidersFromEnv

func ReadGitAuthProvidersFromEnv(environ []string) ([]codersdk.GitAuthConfig, error)

ReadGitAuthProvidersFromEnv is provided for compatibility purposes with the viper CLI. DEPRECATED

func Root

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

func Server

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

nolint:gocyclo