cliui

Documentation

Index

• Variables
• func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error
• func AllowSkipPrompt(cmd *cobra.Command)
• func FilterTableColumns(header table.Row, columns []string) []table.ColumnConfig
• 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 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 PromptOptions
• type ProvisionerJobOptions
• type SelectOptions
• type WorkspaceResourcesOptions

Variables

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

var Styles = struct {
	Bold,
	Checkmark,
	Code,
	Crossmark,
	Error,
	Field,
	Keyword,
	Paragraph,
	Placeholder,
	Prompt,
	FocusedPrompt,
	Fuschia,
	Logo,
	Warn,
	Wrap lipgloss.Style
}{
	Bold:          lipgloss.NewStyle().Bold(true),
	Checkmark:     defaultStyles.Checkmark,
	Code:          defaultStyles.Code,
	Crossmark:     defaultStyles.Error.Copy().SetString("✘"),
	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.Color("240")),
	Prompt:        defaultStyles.Prompt.Foreground(lipgloss.AdaptiveColor{Light: "#9B9B9B", Dark: "#5C5C5C"}),
	FocusedPrompt: defaultStyles.FocusedPrompt.Foreground(lipgloss.Color("#651fff")),
	Fuschia:       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 FilterTableColumns

func FilterTableColumns(header table.Row, columns []string) []table.ColumnConfig

FilterTableColumns returns configurations to hide columns that are not provided in the array. If the array is empty, no filtering will occur!

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 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, before time.Time) 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
}

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, 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 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
}