cli

Documentation

Index

• Variables
• func BuildLogger(inv *clibase.Invocation, cfg *codersdk.DeploymentValues) (slog.Logger, func(), error)
• func ConfigureHTTPClient(ctx context.Context, clientCertFile, clientKeyFile string, ...) (context.Context, *http.Client, error)
• func ConfigureTraceProvider(ctx context.Context, logger slog.Logger, inv *clibase.Invocation, ...) (trace.TracerProvider, string)
• func ContextWithLogger(ctx context.Context, l slog.Logger) context.Context
• func CurrentOrganization(inv *clibase.Invocation, client *codersdk.Client) (codersdk.Organization, error)
• func DumpHandler(ctx context.Context)
• func IsLocalURL(ctx context.Context, u *url.URL) (bool, error)
• func IsLocalhost(host string) bool
• func LoggerFromContext(ctx context.Context) (slog.Logger, bool)
• func ParseProvisionerTags(rawTags []string) (map[string]string, error)
• func PrintDeprecatedOptions() clibase.MiddlewareFunc
• func PrintLogo(inv *clibase.Invocation)
• func ReadGitAuthProvidersFromEnv(environ []string) ([]codersdk.GitAuthConfig, error)
• func ServeHandler(ctx context.Context, logger slog.Logger, handler http.Handler, ...) (closeFunc func())
• func WriteConfigMW(cfg *codersdk.DeploymentValues) clibase.MiddlewareFunc
• type HTTPServers
  • func ConfigureHTTPServers(inv *clibase.Invocation, cfg *codersdk.DeploymentValues) (_ *HTTPServers, err error)
  • func (s *HTTPServers) Close()
  • func (s *HTTPServers) Serve(srv *http.Server) 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 BuildLogger

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

func ConfigureHTTPClient

func ConfigureHTTPClient(ctx context.Context, clientCertFile, clientKeyFile string, tlsClientCAFile string) (context.Context, *http.Client, error)

func ConfigureTraceProvider

func ConfigureTraceProvider(ctx context.Context, logger slog.Logger, inv *clibase.Invocation, cfg *codersdk.DeploymentValues) (trace.TracerProvider, string)

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 DumpHandler

func DumpHandler(ctx context.Context)

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

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

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

On Windows this immediately returns.

func IsLocalURL

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

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

func IsLocalhost

func IsLocalhost(host string) bool

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

func LoggerFromContext

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

func ParseProvisionerTags

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

func PrintDeprecatedOptions

func PrintDeprecatedOptions() clibase.MiddlewareFunc

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

func PrintLogo

func PrintLogo(inv *clibase.Invocation)

nolint: revive

func ReadGitAuthProvidersFromEnv

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

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

func ServeHandler

func ServeHandler(ctx context.Context, logger slog.Logger, handler http.Handler, addr, name string) (closeFunc func())

func WriteConfigMW

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

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

Types

type HTTPServers

type HTTPServers struct {
	HTTPUrl      *url.URL
	HTTPListener net.Listener

	// TLS
	TLSUrl      *url.URL
	TLSListener net.Listener
	TLSConfig   *tls.Config
}

func ConfigureHTTPServers

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

func (*HTTPServers) Close

func (s *HTTPServers) Close()

func (*HTTPServers) Serve

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

Serve acts just like http.Serve. It is a blocking call until the server is closed, and an error is returned if any underlying Serve call fails.

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