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

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

funcBuildLogger¶added inv0.22.1

func BuildLogger(inv *clibase.Invocation, cfg *codersdk.DeploymentValues) (slog.Logger, func(),error)

funcConfigureHTTPClient¶added inv0.22.1

func ConfigureHTTPClient(ctxcontext.Context, clientCertFile, clientKeyFilestring, tlsClientCAFilestring) (context.Context, *http.Client,error)

funcConfigureTraceProvider¶added inv0.22.1

func ConfigureTraceProvider(ctxcontext.Context,loggerslog.Logger,inv *clibase.Invocation,cfg *codersdk.DeploymentValues,) (trace.TracerProvider,string, func(context.Context)error)

funcContextWithLogger¶added inv0.18.0

func ContextWithLogger(ctxcontext.Context, lslog.Logger)context.Context

funcCurrentOrganization¶added inv0.12.0

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

CurrentOrganization returns the currently active organization for the authenticated user.

funcDumpHandler¶added inv0.22.1

func DumpHandler(ctxcontext.Context)

DumpHandler provides a custom SIGQUIT and SIGTRAP handler that dumps thestacktrace of all goroutines to stderr and a well-known file in the homedirectory. This is useful for debugging deadlock issues that may occur inproduction in workspaces, since the default Go runtime will only dump tostderr (which is often difficult/impossible to read in a workspace).

SIGQUITs will still cause the program to exit (similarly to the default Goruntime behavior).

A SIGQUIT handler will not be registered if GOTRACEBACK=crash.

On Windows this immediately returns.

funcIsLocalURL¶added inv0.22.1

func IsLocalURL(ctxcontext.Context, u *url.URL) (bool,error)

isLocalURL returns true if the hostname of the provided URL appears toresolve to a loopback address.

funcIsLocalhost¶added inv0.22.1

func IsLocalhost(hoststring)bool

IsLocalhost returns true if the host points to the local machine. Intended tobe called with `u.Hostname()`.

funcLoggerFromContext¶added inv0.18.0

func LoggerFromContext(ctxcontext.Context) (slog.Logger,bool)

funcParseProvisionerTags¶added inv0.12.8

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

funcPrintDeprecatedOptions¶added inv0.22.1

func PrintDeprecatedOptions()clibase.MiddlewareFunc

printDeprecatedOptions loops through all command options, and printsa warning for usage of deprecated options.

funcPrintLogo¶added inv0.22.1

func PrintLogo(inv *clibase.Invocation, daemonTitlestring)

nolint: revive

funcReadGitAuthProvidersFromEnv¶added inv0.19.0

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

ReadGitAuthProvidersFromEnv is provided for compatibility purposes with theviper CLI.DEPRECATED

funcServeHandler¶added inv0.22.1

func ServeHandler(ctxcontext.Context, loggerslog.Logger, handlerhttp.Handler, addr, namestring) (closeFunc func())

funcWriteConfigMW¶added inv0.22.1

func WriteConfigMW(cfg *codersdk.DeploymentValues)clibase.MiddlewareFunc

writeConfigMW will prevent the main command from running if the write-configflag is set. Instead, it will marshal the command options to YAML and writethem to stdout.

typeHTTPServers¶added inv0.22.1

type HTTPServers struct {HTTPUrl      *url.URLHTTPListenernet.Listener// TLSTLSUrl      *url.URLTLSListenernet.ListenerTLSConfig   *tls.Config}

func ConfigureHTTPServers(inv *clibase.Invocation, cfg *codersdk.DeploymentValues) (_ *HTTPServers, errerror)

func (s *HTTPServers) Close()

func (s *HTTPServers) Serve(srv *http.Server)error

typeRootCmd¶added inv0.21.0

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

RootCmd contains parameters and helpers useful to all commands.

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