cli

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,
	cfg *codersdk.DeploymentValues,
) (trace.TracerProvider, string, func(context.Context) error)

func ConnectToPostgres ¶ added in v2.2.0

func ConnectToPostgres(ctx context.Context, logger slog.Logger, driver string, dbURL string, migrate func(db *sql.DB) error) (*sql.DB, error)

ConnectToPostgres takes in the migration command to run on the database once it connects. To avoid running migrations, pass in `nil` or a no-op function. Regardless of the passed in migration function, if the database is not fully migrated, an error will be returned. This can happen if the database is on a future or past migration version.

If no error is returned, the database is fully migrated and up to date.

func DumpHandler ¶

func DumpHandler(ctx context.Context, name string)

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 ExitError ¶ added in v2.5.0

func ExitError(code int, err error) error

ExitError returns an error that will cause the CLI to exit with the given exit code. If err is non-nil, it will be wrapped by the returned error.

func FormatExamples ¶ added in v2.12.0

func FormatExamples(examples ...Example) string

FormatExamples formats the examples as width wrapped bulletpoint descriptions with the command underneath.

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 ParseProvisionerTags ¶

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

func PrintDeprecatedOptions ¶

func PrintDeprecatedOptions() serpent.MiddlewareFunc

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

func PrintLogo ¶

func PrintLogo(inv *serpent.Invocation, daemonTitle string)

nolint: revive

func ReadExternalAuthProvidersFromEnv ¶ added in v2.2.1

func ReadExternalAuthProvidersFromEnv(environ []string) ([]codersdk.ExternalAuthConfig, error)

ReadExternalAuthProvidersFromEnv is provided for compatibility purposes with the viper CLI.

func ServeHandler ¶

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

func SlimUnsupported ¶ added in v2.1.5

func SlimUnsupported(w io.Writer, cmd string)

func WriteConfigMW ¶

func WriteConfigMW(cfg *codersdk.DeploymentValues) serpent.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.