const (ConfirmYes = "yes"ConfirmNo  = "no")

const (ProvisioningStateQueued  = "Queued"ProvisioningStateRunning = "Running")

var ErrCanceled =xerrors.New("canceled")

funcAgent¶

func Agent(ctxcontext.Context, writerio.Writer, agentIDuuid.UUID, optsAgentOptions)error

Agent displays a spinning indicator that waits for a workspace agent to connect.

funcBold¶added inv2.2.0

func Bold(sstring)string

Bold returns a formatter that renders text in boldif the terminal supports it.

funcBoldFmt¶added inv2.2.0

func BoldFmt()pretty.Formatter

BoldFmt returns a formatter that renders text in boldif the terminal supports it.

funcCode¶added inv2.2.0

func Code(sstring)string

Code formats code for display.

funcColor¶added inv2.2.0

func Color(sstring)termenv.Color

Color returns a color for the given string.

funcDeprecationWarning¶added inv2.7.0

func DeprecationWarning(messagestring)serpent.MiddlewareFunc

funcDisplayTable¶

func DisplayTable(outany, sortstring, filterColumns []string) (string,error)

DisplayTable renders a table as a string. The input argument can be:

• a struct slice.
• an interface slice, where the first element is a struct,and all other elements are of the same type, or a TableSeparator.

At least one field in the struct must have a `table:""` tagcontaining the name of the column in the outputted table.

If `sort` is not specified, the field with the `table:"$NAME,default_sort"`tag will be used to sort. An error will be returned if no field has this tag.

Nested structs are processed if the field has the `table:"$NAME,recursive"`tag and their fields will be named as `$PARENT_NAME $NAME`. If the tag ismalformed or a field is marked as recursive but does not contain a struct ora pointer to a struct, this function will return an error (even with an emptyinput slice).

If sort is empty, the input order will be used. If filterColumns is empty ornil, all available columns are included.

funcError¶

func Error(wtrio.Writer, headerstring, lines ...string)

Error writes a log to the writer provided.

funcErrorf¶

func Errorf(wtrio.Writer, fmtStrstring, args ...interface{})

Errorf writes a formatted log to the writer provided.

funcExternalAuth¶added inv2.2.1

func ExternalAuth(ctxcontext.Context, writerio.Writer, optsExternalAuthOptions)error

funcField¶added inv2.2.0

func Field(sstring)string

Field formats a field for display.

funcInfo¶

func Info(wtrio.Writer, headerstring, lines ...string)

Info writes a log to the writer provided.

funcInfof¶

func Infof(wtrio.Writer, fmtStrstring, args ...interface{})

Infof writes a formatted log to the writer provided.

funcKeyword¶added inv2.2.0

func Keyword(sstring)string

Keyword formats a keyword for display.

funcMultiSelect¶

func MultiSelect(inv *serpent.Invocation, optsMultiSelectOptions) ([]string,error)

funcPeerDiagnostics¶added inv2.9.0

func PeerDiagnostics(wio.Writer, dtailnet.PeerDiagnostics)

funcPlaceholder¶added inv2.2.0

func Placeholder(sstring)string

Placeholder formats a placeholder for display.

funcPrompt¶

func Prompt(inv *serpent.Invocation, optsPromptOptions) (string,error)

Prompt asks the user for input.

funcProvisionerJob¶

func ProvisionerJob(ctxcontext.Context, wrio.Writer, optsProvisionerJobOptions)error

ProvisionerJob renders a provisioner job with interactive cancellation.

funcRichParameter¶

func RichParameter(inv *serpent.Invocation, templateVersionParametercodersdk.TemplateVersionParameter, defaultOverrides map[string]string) (string,error)

funcRichSelect¶

func RichSelect(inv *serpent.Invocation, richOptionsRichSelectOptions) (*codersdk.TemplateVersionParameterOption,error)

RichSelect displays a list of user options including name and description.

funcSelect¶

func Select(inv *serpent.Invocation, optsSelectOptions) (string,error)

Select displays a list of user options.

funcSkipPromptOption¶

func SkipPromptOption()serpent.Option

SkipPromptOption adds a "--yes/-y" flag to the cmd that can be used to skipprompts.

funcTable¶

func Table()table.Writer

Table creates a new table with standardized styles.

funcTimestamp¶added inv2.2.0

func Timestamp(ttime.Time)string

Timestamp formats a timestamp for display.

funcValidateNotEmpty¶

func ValidateNotEmpty(sstring)error

ValidateNotEmpty is a helper function to disallow empty inputs!

funcWarn¶

func Warn(wtrio.Writer, headerstring, lines ...string)

Warn writes a log to the writer provided.

funcWarnf¶

func Warnf(wtrio.Writer, fmtStrstring, args ...interface{})

Warn writes a formatted log to the writer provided.

funcWorkspaceBuild¶

func WorkspaceBuild(ctxcontext.Context, writerio.Writer, client *codersdk.Client, builduuid.UUID)error

funcWorkspaceResources¶

func WorkspaceResources(writerio.Writer, resources []codersdk.WorkspaceResource, optionsWorkspaceResourcesOptions)error

WorkspaceResources displays the connection status and tree-view of provided resources.┌────────────────────────────────────────────────────────────────────────────┐│ RESOURCE STATUS ACCESS │├────────────────────────────────────────────────────────────────────────────┤│ google_compute_disk.root │├────────────────────────────────────────────────────────────────────────────┤│ google_compute_instance.dev ││ └─ dev (linux, amd64) ⦾ connecting [10s] coder ssh dev.dev │├────────────────────────────────────────────────────────────────────────────┤│ kubernetes_pod.dev ││ ├─ go (linux, amd64) ⦿ connected coder ssh dev.go ││ └─ postgres (linux, amd64) ⦾ disconnected [4s] coder ssh dev.postgres │└────────────────────────────────────────────────────────────────────────────┘

funcWrap¶added inv2.2.0

func Wrap(sstring)string

Wrap prevents the text from overflowing the terminal.

typeAgentOptions¶

type AgentOptions struct {FetchIntervaltime.DurationFetch         func(ctxcontext.Context, agentIDuuid.UUID) (codersdk.WorkspaceAgent,error)FetchLogs     func(ctxcontext.Context, agentIDuuid.UUID, afterint64, followbool) (<-chan []codersdk.WorkspaceAgentLog,io.Closer,error)Waitbool// If true, wait for the agent to be ready (startup script).DocsURLstring}

typeConnDiags¶added inv2.15.0

type ConnDiags struct {ConnInfoworkspacesdk.AgentConnectionInfoPingP2PboolDisableDirectboolLocalNetInfo       *tailcfg.NetInfoLocalInterfaces    *healthsdk.InterfacesReportAgentNetcheck      *healthsdk.AgentNetcheckReportClientIPIsAWSboolAgentIPIsAWSboolVerboseboolTroubleshootingURLstring}

func (dConnDiags) Write(wio.Writer)

typeDataChangeFormat¶

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

DataChangeFormat allows manipulating the data passed to an output format.This is because sometimes the data needs to be manipulated before it can bepassed to the output format.For example, you may want to pass something different to the text formatterthan what you pass to the json formatter.

func ChangeFormatterData(formatOutputFormat, change func(dataany) (any,error)) *DataChangeFormat

func (d *DataChangeFormat) AttachOptions(opts *serpent.OptionSet)

func (d *DataChangeFormat) Format(ctxcontext.Context, dataany) (string,error)

func (d *DataChangeFormat) ID()string

typeExternalAuthOptions¶added inv2.2.1

type ExternalAuthOptions struct {Fetch         func(context.Context) ([]codersdk.TemplateVersionExternalAuth,error)FetchIntervaltime.Duration}

typeMultiSelectOptions¶added inv2.13.0

type MultiSelectOptions struct {MessagestringOptions           []stringDefaults          []stringEnableCustomInputbool}

typeOutputFormat¶

type OutputFormat interface {ID()stringAttachOptions(opts *serpent.OptionSet)Format(ctxcontext.Context, dataany) (string,error)}

func JSONFormat()OutputFormat

func TableFormat(outany, defaultColumns []string)OutputFormat

func TextFormat()OutputFormat

typeOutputFormatter¶

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

func NewOutputFormatter(formats ...OutputFormat) *OutputFormatter

func (f *OutputFormatter) AttachOptions(opts *serpent.OptionSet)

func (f *OutputFormatter) Format(ctxcontext.Context, dataany) (string,error)

func (f *OutputFormatter) FormatID()string

typePromptOptions¶

type PromptOptions struct {TextstringDefaultstring// When true, the input will be masked with asterisks.SecretboolIsConfirmboolValidate  func(string)error}

PromptOptions supply a set of options to the prompt.

typeProvisionerJobError¶

type ProvisionerJobError struct {MessagestringCodecodersdk.JobErrorCode}

func (err *ProvisionerJobError) Error()string

typeProvisionerJobOptions¶

type ProvisionerJobOptions struct {Fetch  func() (codersdk.ProvisionerJob,error)Cancel func()errorLogs   func() (<-chancodersdk.ProvisionerJobLog,io.Closer,error)FetchIntervaltime.Duration// Verbose determines whether debug and trace logs will be shown.Verbosebool// Silent determines whether log output will be shown unless there is an// error.Silentbool}

typeRichSelectOptions¶

type RichSelectOptions struct {Options    []codersdk.TemplateVersionParameterOptionDefaultstringSizeintHideSearchbool}

typeSelectOptions¶

type SelectOptions struct {Options []string// Default will be highlighted first if it's a valid option.DefaultstringMessagestringSizeintHideSearchbool}

typeStyles¶

type Styles struct {Code,DateTimeStamp,Error,Field,Hyperlink,Keyword,Placeholder,Prompt,FocusedPrompt,Fuchsia,Warn,Wrappretty.Style}

var DefaultStylesStyles

typeTableSeparator¶added inv2.13.0

type TableSeparator struct{}

This type can be supplied as part of a slice to DisplayTableor to a `TableFormat` `Format` call to render a separator.Leading separators are not supported and trailing separatorsare ignored by the table formatter.e.g. `[]any{someRow, TableSeparator, someRow}`

typeWorkspaceFilter¶added inv2.4.0

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

WorkspaceFilter wraps codersdk.WorkspaceFilterand allows easy integration to a CLI command.Example usage:

func (r *RootCmd) MyCmd() *serpent.Command {  var (    filter cliui.WorkspaceFilter    ...  )  cmd := &serpent.Command{    ...  }  filter.AttachOptions(&cmd.Options)  ...  return cmd}

The above will add the following flags to the command:--all--search

func (w *WorkspaceFilter) AttachOptions(opts *serpent.OptionSet)

func (w *WorkspaceFilter) Filter()codersdk.WorkspaceFilter

typeWorkspaceResourcesOptions¶

type WorkspaceResourcesOptions struct {WorkspaceNamestringHideAgentStateboolHideAccessboolTitlestringServerVersionstringListeningPorts map[uuid.UUID]codersdk.WorkspaceAgentListeningPortsResponseDevcontainers  map[uuid.UUID]codersdk.WorkspaceAgentListContainersResponse}