cliui

package

v0.3.0 Latest Latest Go to latest Published: Mar 26, 2026 License: AGPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/papercomputeco/tapes

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cliui provides reusable terminal UI helpers (spinners, step indicators, markdown rendering) for tapes CLI commands.

Index ¶

Variables
func FormatDuration(d time.Duration) string
func Mark(err error) string
func RenderMarkdown(content string) (string, error)
func Step(w io.Writer, msg string, fn func() error) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	SuccessMark = lipgloss.NewStyle().Foreground(lipgloss.Color("82")).Render("✓")
	FailMark    = lipgloss.NewStyle().Foreground(lipgloss.Color("196")).Render("✗")
	StepStyle   = lipgloss.NewStyle().Foreground(lipgloss.Color("245"))

	// Shared styles for CLI output formatting.
	NameStyle    = lipgloss.NewStyle().Foreground(lipgloss.Color("82")).Bold(true)
	DimStyle     = lipgloss.NewStyle().Foreground(lipgloss.Color("241"))
	HashStyle    = lipgloss.NewStyle().Foreground(lipgloss.Color("39"))
	TagStyle     = lipgloss.NewStyle().Foreground(lipgloss.Color("39"))
	ScoreStyle   = lipgloss.NewStyle().Foreground(lipgloss.Color("245"))
	RoleStyle    = lipgloss.NewStyle().Foreground(lipgloss.Color("245"))
	PreviewStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("252"))
	MatchedStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("82")).Bold(true)
	BranchStyle  = lipgloss.NewStyle().Foreground(lipgloss.Color("245"))
	HeaderStyle  = lipgloss.NewStyle().Foreground(lipgloss.Color("252")).Bold(true)
	RankStyle    = lipgloss.NewStyle().Foreground(lipgloss.Color("82")).Bold(true)
	WarnStyle    = lipgloss.NewStyle().Foreground(lipgloss.Color("214"))
	KeyStyle     = lipgloss.NewStyle().Foreground(lipgloss.Color("245"))
	ValueStyle   = lipgloss.NewStyle().Foreground(lipgloss.Color("252"))
)

Functions ¶

func FormatDuration ¶

func FormatDuration(d time.Duration) string

FormatDuration formats a duration for display (e.g. "12ms" or "3.2s").

func Mark ¶

func Mark(err error) string

Mark returns a ✓ for nil errors or ✗ for non-nil errors.

func RenderMarkdown ¶

func RenderMarkdown(content string) (string, error)

RenderMarkdown renders markdown content for terminal display using glamour.

func Step ¶

func Step(w io.Writer, msg string, fn func() error) error

Step prints an animated spinner while fn runs, then replaces it with a ✓ or ✗ checkmark and elapsed time.

Types ¶

This section is empty.

Source Files ¶

View all Source files

cliui.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL