cli

Documentation

Index

• Variables
• func ContextWithLogger(ctx context.Context, l slog.Logger) context.Context
• func CurrentOrganization(inv *clibase.Invocation, client *codersdk.Client) (codersdk.Organization, error)
• func LoggerFromContext(ctx context.Context) (slog.Logger, bool)
• func ParseProvisionerTags(rawTags []string) (map[string]string, error)
• func ReadGitAuthProvidersFromEnv(environ []string) ([]codersdk.GitAuthConfig, error)
• type RootCmd
  • func (r *RootCmd) AGPL() []*clibase.Cmd
  • func (r *RootCmd) Command(subcommands []*clibase.Cmd) (*clibase.Cmd, error)
  • func (r *RootCmd) Core() []*clibase.Cmd
  • func (r *RootCmd) InitClient(client *codersdk.Client) clibase.MiddlewareFunc
  • func (r *RootCmd) RunMain(subcommands []*clibase.Cmd)
  • func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.API, io.Closer, error)) *clibase.Cmd

Variables

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

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

Functions

func ContextWithLogger

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

func CurrentOrganization

func CurrentOrganization(inv *clibase.Invocation, client *codersdk.Client) (codersdk.Organization, error)

CurrentOrganization returns the currently active organization for the authenticated user.

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

Types

type RootCmd

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

RootCmd contains parameters and helpers useful to all commands.

func (*RootCmd) AGPL

func (r *RootCmd) AGPL() []*clibase.Cmd

func (*RootCmd) Command

func (r *RootCmd) Command(subcommands []*clibase.Cmd) (*clibase.Cmd, error)

func (*RootCmd) Core

func (r *RootCmd) Core() []*clibase.Cmd

func (*RootCmd) InitClient

func (r *RootCmd) InitClient(client *codersdk.Client) clibase.MiddlewareFunc

InitClient sets client to a new client. It reads from global configuration files if flags are not set.

func (*RootCmd) RunMain

func (r *RootCmd) RunMain(subcommands []*clibase.Cmd)

Main is the entrypoint for the Coder CLI.

func (*RootCmd) Server

func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.API, io.Closer, error)) *clibase.Cmd

nolint:gocyclo