agentleFS
aaronfloreyaaronflorey/agent-skills/skills/charmbracelet/SKILL.md

charmbracelet

Skill2 starsChanged 7 months agoMITView on GitHub

Build Go terminal user interfaces and interactive CLIs with the Charmbracelet ecosystem, especially Bubble Tea, Bubbles, Huh, Lip Gloss, Wish, Glamour, and Log. Use this skill when the user asks for a TUI, terminal UI, interactive CLI, Bubble Tea model/update/view code, Bubbles widgets, Huh forms, Lip Gloss layout or styling, Wish SSH apps, Glamour markdown rendering, or a polished Go terminal app.

The file

Show its rules and text

We split this skill into the rules it gives an agent

21 rules. About 0 are common, 15 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈15

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill to build modern Go CLIs with the Charmbracelet stack.

    line 9
  2. Very specific:

    Use charm.land/.../v2 imports for the current v2 ecosystem.

    line 13
  3. Distinctive:

    Treat Bubble Tea as the app runtime and state machine.

    line 14
  4. Distinctive:

    Treat Bubbles as reusable widgets, not the app shell.

    line 15
  5. Distinctive:

    Treat Lip Gloss as layout and styling.

    line 16
  6. Distinctive:

    Treat Huh as the fastest way to build forms and wizards.

    line 17
  7. Distinctive:

    Treat Glamour as markdown-to-ANSI rendering.

    line 18
  8. Very specific:

    Treat Log as diagnostics to stderr or files, not to the TUI surface.

    line 19
  9. Distinctive:

    Treat Wish as the SSH transport layer for remote terminal apps.

    line 20
  10. Distinctive:

    Start with Bubble Tea when the user asks for a TUI, terminal UI, dashboard, picker, wizard, or interactive CLI.

    line 41
  11. Distinctive:

    Add Bubbles instead of rebuilding common widgets by hand.

    line 42
  12. Distinctive:

    Add Lip Gloss once layout or visual hierarchy matters.

    line 43
  13. Distinctive:

    Add Huh when the interaction is form-heavy.

    line 44
  14. Distinctive:

    Add Glamour when the app renders markdown content.

    line 45
  15. Distinctive:

    Add Log for diagnostics, background jobs, or server logs.

    line 46
  16. Distinctive:

    Add Wish only when the app should run over SSH.

    line 47
  17. Distinctive:

    Keep business logic separate from the Bubble Tea model.

    line 51
  18. Very specific:

    Do I/O in tea.Cmd, not directly in Update or View.

    line 52
  19. Very specific:

    Read references/bubbletea-core.md for Bubble Tea's model, commands, messages, and program lifecycle.

    line 92
  20. Very specific:

    Read references/bubbletea-patterns.md for app structure, async work, Cobra integration, and multi-model composition.

    line 93
  21. Very specific:

    Read references/troubleshooting-workarounds.md before migrating old Charmbracelet code or mixing stale examples with v2 code.

    line 94

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Use this skill to build modern Go CLIs with the Charmbracelet stack. Default to Bubble Tea for any stateful TUI or interactive terminal flow, then layer in Bubbles, Huh, Lip Gloss, Wish, Glamour, and Log as needed.

Start Here

  • Use charm.land/.../v2 imports for the current v2 ecosystem.
  • Treat Bubble Tea as the app runtime and state machine.
  • Treat Bubbles as reusable widgets, not the app shell.
  • Treat Lip Gloss as layout and styling.
  • Treat Huh as the fastest way to build forms and wizards.
  • Treat Glamour as markdown-to-ANSI rendering.
  • Treat Log as diagnostics to stderr or files, not to the TUI surface.
  • Treat Wish as the SSH transport layer for remote terminal apps.

When To Reach For Which Library

NeedUse
Full TUI, app state, key handling, message loopreferences/bubbletea-core.md
Real app architecture, commands, child models, async patternsreferences/bubbletea-patterns.md
Reusable widgets like list, table, textinput, viewport, helpreferences/bubbles.md
Forms, prompts, wizards, embedded form screensreferences/huh.md
Styling, spacing, borders, color, layout compositionreferences/lipgloss.md
SSH-native TUI or remote CLI appreferences/wish.md
Markdown help panes, docs, release notes, previewsreferences/glamour.md
Structured CLI logging and diagnosticsreferences/log.md
High-level library chooser and API mapreferences/api-surface.md
Concrete implementation recipesreferences/common-use-cases.md
Migration issues and footgunsreferences/troubleshooting-workarounds.md
Upstream example shortlistreferences/examples.md

Default Build Strategy

  1. Start with Bubble Tea when the user asks for a TUI, terminal UI, dashboard, picker, wizard, or interactive CLI.
  2. Add Bubbles instead of rebuilding common widgets by hand.
  3. Add Lip Gloss once layout or visual hierarchy matters.
  4. Add Huh when the interaction is form-heavy.
  5. Add Glamour when the app renders markdown content.
  6. Add Log for diagnostics, background jobs, or server logs.
  7. Add Wish only when the app should run over SSH.

Core Rules

  • Keep business logic separate from the Bubble Tea model.
  • Do I/O in tea.Cmd, not directly in Update or View.
  • Handle resize with tea.WindowSizeMsg and keep layouts responsive.
  • Request background color with tea.RequestBackgroundColor when styles depend on light/dark mode.
  • In Bubble Tea v2, declare terminal behavior in tea.View fields like AltScreen and MouseMode.
  • In standalone Lip Gloss or Glamour output, print with Lip Gloss writers so color downsampling works.
  • In Wish apps, remember middleware runs in reverse declaration order.
  • In Bubble Tea apps, write logs to stderr or a file, not to stdout.

Bubble Tea First Skeleton

package main

import tea "charm.land/bubbletea/v2"

type model struct{}

func (m model) Init() tea.Cmd {
    return nil
}

func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    switch msg := msg.(type) {
    case tea.KeyPressMsg:
        switch msg.String() {
        case "q", "ctrl+c":
            return m, tea.Quit
        }
    }
    return m, nil
}

func (m model) View() tea.View {
    v := tea.NewView("Hello from Bubble Tea")
    return v
}

Read These Next

  • Read references/bubbletea-core.md for Bubble Tea's model, commands, messages, and program lifecycle.
  • Read references/bubbletea-patterns.md for app structure, async work, Cobra integration, and multi-model composition.
  • Read references/troubleshooting-workarounds.md before migrating old Charmbracelet code or mixing stale examples with v2 code.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.