ui

package

v0.26.2 Latest Latest Go to latest Published: Jun 12, 2026 License: MIT Imports: 8 Imported by: 0

Details

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

Repository

github.com/mvaliolahi/tinker

Links

Open Source Insights

Documentation ¶

Index ¶

func APILabel() string
func Accent(text string) string
func AccentPanel(title, content string) string
func Banner(version string) string
func Bold(text string) string
func Bullet(label, value string) string
func CfgLabel() string
func DBLabel() string
func Dashboard(cfg DashboardConfig) string
func DepStatus(name string, installed bool, purpose string) string
func Dim(text string) string
func Error(text string) string
func FormatCount(count int64) string
func GRPCLabel() string
func HTTPMethod(method string) string
func Highlight(source, language string) string
func HighlightGo(code string) string
func HighlightJSON(json string) string
func HighlightSQL(sql string) string
func HighlightTOML(toml string) string
func HighlightYAML(yaml string) string
func Hint(text string) string
func KeyValue(label, value string) string
func LogLabel() string
func MakeLabel() string
func NumberedList(items []string) string
func Panel(title, content string) string
func RunLabel() string
func Section(title string) string
func Step(num int, label string) string
func StepDone(num int, label string) string
func Success(text string) string
func Table(headers []string, rows [][]string) string
func Warning(text string) string
type DashboardConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func APILabel ¶

func APILabel() string

func Accent ¶

func Accent(text string) string

func AccentPanel ¶ added in v0.9.0

func AccentPanel(title, content string) string

func Banner ¶

func Banner(version string) string

func Bold ¶

func Bold(text string) string

func Bullet ¶

func Bullet(label, value string) string

func CfgLabel ¶ added in v0.19.0

func CfgLabel() string

func DBLabel ¶

func DBLabel() string

func Dashboard ¶ added in v0.9.0

func Dashboard(cfg DashboardConfig) string

Dashboard renders the main dashboard view.

func DepStatus ¶

func DepStatus(name string, installed bool, purpose string) string

func Dim ¶

func Dim(text string) string

func Error ¶

func Error(text string) string

func FormatCount ¶ added in v0.25.0

func FormatCount(count int64) string

FormatCount returns a styled count value.

func GRPCLabel ¶

func GRPCLabel() string

func HTTPMethod ¶ added in v0.9.0

func HTTPMethod(method string) string

func Highlight ¶ added in v0.25.0

func Highlight(source, language string) string

Highlight applies syntax highlighting to source code. language should be a Chroma lexer name: "sql", "json", "yaml", "go", "toml", etc. Falls back to plain text if highlighting fails.

func HighlightGo ¶ added in v0.25.0

func HighlightGo(code string) string

HighlightGo highlights Go source code.

func HighlightJSON ¶ added in v0.25.0

func HighlightJSON(json string) string

HighlightJSON highlights a JSON string.

func HighlightSQL ¶ added in v0.25.0

func HighlightSQL(sql string) string

HighlightSQL highlights a SQL statement.

func HighlightTOML ¶ added in v0.25.0

func HighlightTOML(toml string) string

HighlightTOML highlights a TOML string.

func HighlightYAML ¶ added in v0.25.0

func HighlightYAML(yaml string) string

HighlightYAML highlights a YAML string.

func Hint ¶ added in v0.9.0

func Hint(text string) string

func KeyValue ¶

func KeyValue(label, value string) string

func LogLabel ¶ added in v0.14.0

func LogLabel() string

func MakeLabel ¶

func MakeLabel() string

func NumberedList ¶ added in v0.9.0

func NumberedList(items []string) string

func Panel ¶ added in v0.9.0

func Panel(title, content string) string

func RunLabel ¶ added in v0.9.0

func RunLabel() string

func Section ¶

func Section(title string) string

func Step ¶ added in v0.9.0

func Step(num int, label string) string

func StepDone ¶ added in v0.9.0

func StepDone(num int, label string) string

func Success ¶

func Success(text string) string

func Table ¶ added in v0.9.0

func Table(headers []string, rows [][]string) string

func Warning ¶

func Warning(text string) string

Types ¶

type DashboardConfig ¶ added in v0.19.0

type DashboardConfig struct {
	ProjectDir  string
	HasDB       bool
	DBInfo      string // e.g. "SQLite • apartment.db" or "Postgres • localhost:5432/mydb"
	HasAPI      bool
	APIInfo     string // e.g. "localhost:8080"
	HasGRPC     bool
	GRPCInfo    string // e.g. "localhost:50051"
	HasLog      bool
	HasDocker   bool
	DockerInfo  string // e.g. "3 services (docker-compose.yml)"
	MissingDeps int
	Version     string
	Env         string // active environment name (empty = default)
}

DashboardConfig holds all parameters for rendering the dashboard.

Source Files ¶

View all Source files

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