charm-tui

A minimal Charm terminal UI starter built on Bubble Tea v2, packaged as a spin template. Every Charm library except the Bubble Tea runtime is optional, so you scaffold only what you need.

What's included

• Bubble Tea: the TUI lib, charm.land/bubbletea/v2 (Elm-architecture model)
• Bubbles (optional): spinner, help bar, and a tab bar (Welcome / Commands)
• Lip Gloss (optional): gradient title, borders, and layout
• Glamour (optional): markdown rendering for the Commands tab
• CharmTone (optional): dark global background
• Taskfile (optional): go-task tasks for build / run / test / lint / fmt / tidy

Use it

# from the official registry
spin registry update
spin new my-app official/charm-tui

# or directly from this repo
spin new my-app https://github.com/spin-templates/charm-tui

spin new prompts for each option (project name, description, module path, and which libraries to include); pass --param use_bubbles=false and friends to scaffold non-interactively. Omitting Bubbles removes the tabs and shows a plain welcome screen.

Keys

Key	Action
← / →	Switch tab
1 2	Jump to a tab
q / ctrl+c	Quit

Run / build

go run .
go build ./...
go test ./...

# with the Taskfile option:
task run
task build   # outputs ./bin/<name>

License MIT