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

var Canceled =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.

funcDisplayTable¶added inv0.8.6

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

DisplayTable renders a table as a string. The input argument must be a sliceof structs. 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¶added inv0.21.0

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

Error writes a log to the writer provided.

funcErrorf¶added inv0.21.0

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

Errorf writes a formatted log to the writer provided.

funcGitAuth¶added inv0.18.0

func GitAuth(ctxcontext.Context, writerio.Writer, optsGitAuthOptions)error

funcInfo¶added inv0.21.0

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

Info writes a log to the writer provided.

funcInfof¶added inv0.21.0

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

Infof writes a formatted log to the writer provided.

funcMultiSelect¶added inv0.20.0

func MultiSelect(inv *clibase.Invocation, items []string) ([]string,error)

funcPrompt¶

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

Prompt asks the user for input.

funcProvisionerJob¶

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

ProvisionerJob renders a provisioner job with interactive cancellation.

funcRichParameter¶added inv0.15.2

func RichParameter(inv *clibase.Invocation, templateVersionParametercodersdk.TemplateVersionParameter) (string,error)

funcRichSelect¶added inv0.15.3

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

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

funcSelect¶

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

Select displays a list of user options.

funcSkipPromptOption¶added inv0.21.0

func SkipPromptOption()clibase.Option

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

funcTable¶added inv0.5.6

func Table()table.Writer

Table creates a new table with standardized styles.

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¶added inv0.21.0

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¶added inv0.4.1

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 │└────────────────────────────────────────────────────────────────────────────┘

typeAgentOptions¶

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

typeDataChangeFormat¶added inv0.23.0

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 *clibase.OptionSet)

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

func (d *DataChangeFormat) ID()string

typeGitAuthOptions¶added inv0.18.0

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

typeOutputFormat¶added inv0.17.1

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

func JSONFormat()OutputFormat

func TableFormat(outany, defaultColumns []string)OutputFormat

func TextFormat()OutputFormat

typeOutputFormatter¶added inv0.17.1

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

func NewOutputFormatter(formats ...OutputFormat) *OutputFormatter

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

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

typePromptOptions¶

type PromptOptions struct {TextstringDefaultstringSecretboolIsConfirmboolValidate  func(string)error}

PromptOptions supply a set of options to the prompt.

typeProvisionerJobError¶added inv0.19.0

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¶added inv0.15.3

type RichSelectOptions struct {Options    []codersdk.TemplateVersionParameterOptionDefaultstringSizeintHideSearchbool}

typeSelectOptions¶

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

typeStyles¶

type Styles struct {Bold,Checkmark,Code,Crossmark,DateTimeStamp,Error,Field,Keyword,Paragraph,Placeholder,Prompt,FocusedPrompt,Fuchsia,Logo,Warn,Wraplipgloss.Style}

var DefaultStylesStyles

typeWorkspaceResourcesOptions¶added inv0.4.1

type WorkspaceResourcesOptions struct {WorkspaceNamestringHideAgentStateboolHideAccessboolTitlestringServerVersionstring}