cliui

Documentation

Index

• Constants
• Variables
• func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error
• func AllowSkipPrompt(cmd *cobra.Command)
• func DisplayTable(out any, sort string, filterColumns []string) (string, error)
• func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.ParameterSchema) (string, error)
• func Prompt(cmd *cobra.Command, opts PromptOptions) (string, error)
• func ProvisionerJob(ctx context.Context, writer io.Writer, opts ProvisionerJobOptions) error
• func RichParameter(cmd *cobra.Command, templateVersionParameter codersdk.TemplateVersionParameter) (string, error)
• func RichSelect(cmd *cobra.Command, richOptions RichSelectOptions) (*codersdk.TemplateVersionParameterOption, error)
• func Select(cmd *cobra.Command, opts SelectOptions) (string, error)
• func Table() table.Writer
• func ValidateNotEmpty(s string) error
• func Warn(wtr io.Writer, header string, lines ...string)
• func WorkspaceBuild(ctx context.Context, writer io.Writer, client *codersdk.Client, ...) error
• func WorkspaceResources(writer io.Writer, resources []codersdk.WorkspaceResource, ...) error
• type AgentOptions
• type OutputFormat
  • func JSONFormat() OutputFormat
  • func TableFormat(out any, defaultColumns []string) OutputFormat
• type OutputFormatter
  • func NewOutputFormatter(formats ...OutputFormat) *OutputFormatter
  • func (f *OutputFormatter) AttachFlags(cmd *cobra.Command)
  • func (f *OutputFormatter) Format(ctx context.Context, data any) (string, error)
• type PromptOptions
• type ProvisionerJobOptions
• type RichSelectOptions
• type SelectOptions
• type WorkspaceResourcesOptions

Constants

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

Variables

var AgentStartError = xerrors.New("agent startup exited with non-zero exit status")

var (
	Canceled = xerrors.New("canceled")
)

var Styles = struct {
	Bold,
	Checkmark,
	Code,
	Crossmark,
	DateTimeStamp,
	Error,
	Field,
	Keyword,
	Paragraph,
	Placeholder,
	Prompt,
	FocusedPrompt,
	Fuchsia,
	Logo,
	Warn,
	Wrap lipgloss.Style
}{
	Bold:          lipgloss.NewStyle().Bold(true),
	Checkmark:     defaultStyles.Checkmark,
	Code:          defaultStyles.Code,
	Crossmark:     defaultStyles.Error.Copy().SetString("✘"),
	DateTimeStamp: defaultStyles.LabelDim,
	Error:         defaultStyles.Error,
	Field:         defaultStyles.Code.Copy().Foreground(lipgloss.AdaptiveColor{Light: "#000000", Dark: "#FFFFFF"}),
	Keyword:       defaultStyles.Keyword,
	Paragraph:     defaultStyles.Paragraph,
	Placeholder:   lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{Light: "#585858", Dark: "#4d46b3"}),
	Prompt:        defaultStyles.Prompt.Foreground(lipgloss.AdaptiveColor{Light: "#9B9B9B", Dark: "#5C5C5C"}),
	FocusedPrompt: defaultStyles.FocusedPrompt.Foreground(lipgloss.Color("#651fff")),
	Fuchsia:       defaultStyles.SelectedMenuItem.Copy(),
	Logo:          defaultStyles.Logo.SetString("Coder"),
	Warn:          lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{Light: "#04B575", Dark: "#ECFD65"}),
	Wrap:          lipgloss.NewStyle().Width(80),
}

Styles compose visual elements of the UI!

Functions

func Agent

func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error

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

func AllowSkipPrompt

func AllowSkipPrompt(cmd *cobra.Command)

func DisplayTable

func DisplayTable(out any, sort string, filterColumns []string) (string, error)

DisplayTable renders a table as a string. The input argument must be a slice of structs. At least one field in the struct must have a `table:""` tag containing 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 is malformed or a field is marked as recursive but does not contain a struct or a pointer to a struct, this function will return an error (even with an empty input slice).

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

func ParameterSchema

func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.ParameterSchema) (string, error)

func Prompt

func Prompt(cmd *cobra.Command, opts PromptOptions) (string, error)

Prompt asks the user for input.

func ProvisionerJob

func ProvisionerJob(ctx context.Context, writer io.Writer, opts ProvisionerJobOptions) error

ProvisionerJob renders a provisioner job with interactive cancellation.

func RichParameter

func RichParameter(cmd *cobra.Command, templateVersionParameter codersdk.TemplateVersionParameter) (string, error)

func RichSelect

func RichSelect(cmd *cobra.Command, richOptions RichSelectOptions) (*codersdk.TemplateVersionParameterOption, error)

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

func Select

func Select(cmd *cobra.Command, opts SelectOptions) (string, error)

Select displays a list of user options.

func Table

func Table() table.Writer

Table creates a new table with standardized styles.

func ValidateNotEmpty

func ValidateNotEmpty(s string) error

ValidateNotEmpty is a helper function to disallow empty inputs!

func Warn

func Warn(wtr io.Writer, header string, lines ...string)

Warn writes a log to the writer provided.

func WorkspaceBuild

func WorkspaceBuild(ctx context.Context, writer io.Writer, client *codersdk.Client, build uuid.UUID) error

func WorkspaceResources

func WorkspaceResources(writer io.Writer, resources []codersdk.WorkspaceResource, options WorkspaceResourcesOptions) 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 │ └────────────────────────────────────────────────────────────────────────────┘

Types

type AgentOptions

type AgentOptions struct {
	WorkspaceName string
	Fetch         func(context.Context) (codersdk.WorkspaceAgent, error)
	FetchInterval time.Duration
	WarnInterval  time.Duration
	NoWait        bool // If true, don't wait for the agent to be ready.
}

type OutputFormat

type OutputFormat interface {
	ID() string
	AttachFlags(cmd *cobra.Command)
	Format(ctx context.Context, data any) (string, error)
}

func JSONFormat

func JSONFormat() OutputFormat

JSONFormat creates a JSON formatter.

func TableFormat

func TableFormat(out any, defaultColumns []string) OutputFormat

TableFormat creates a table formatter for the given output type. The output type should be specified as an empty slice of the desired type.

E.g.: TableFormat([]MyType{}, []string{"foo", "bar"})

defaultColumns is optional and specifies the default columns to display. If not specified, all columns are displayed by default.

type OutputFormatter

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

func NewOutputFormatter

func NewOutputFormatter(formats ...OutputFormat) *OutputFormatter

NewOutputFormatter creates a new OutputFormatter with the given formats. The first format is the default format. At least two formats must be provided.

func (*OutputFormatter) AttachFlags

func (f *OutputFormatter) AttachFlags(cmd *cobra.Command)

AttachFlags attaches the --output flag to the given command, and any additional flags required by the output formatters.

func (*OutputFormatter) Format

func (f *OutputFormatter) Format(ctx context.Context, data any) (string, error)

Format formats the given data using the format specified by the --output flag. If the flag is not set, the default format is used.

type PromptOptions

type PromptOptions struct {
	Text      string
	Default   string
	Secret    bool
	IsConfirm bool
	Validate  func(string) error
}

PromptOptions supply a set of options to the prompt.

type ProvisionerJobOptions

type ProvisionerJobOptions struct {
	Fetch  func() (codersdk.ProvisionerJob, error)
	Cancel func() error
	Logs   func() (<-chan codersdk.ProvisionerJobLog, io.Closer, error)

	FetchInterval time.Duration
	// Verbose determines whether debug and trace logs will be shown.
	Verbose bool
	// Silent determines whether log output will be shown unless there is an
	// error.
	Silent bool
}

type RichSelectOptions

type RichSelectOptions struct {
	Options    []codersdk.TemplateVersionParameterOption
	Default    string
	Size       int
	HideSearch bool
}

type SelectOptions

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

type WorkspaceResourcesOptions

type WorkspaceResourcesOptions struct {
	WorkspaceName  string
	HideAgentState bool
	HideAccess     bool
	Title          string
	ServerVersion  string
}