🎭 Charmer

Charmer is a Go package that automatically generates Terminal User Interfaces (TUIs) from your Go functions. Powered by Charm libraries, it transforms annotated functions into beautiful, navigable command-line interfaces without the hassle of UI implementation.

📚 Documentation

✨ Features

🎯 Simple Integration - Just annotate your functions with @Charm
🌳 Automatic TUI Generation - Create hierarchical menus with zero UI code
⚡ Charm-Powered - Built on the robust Bubbles and BubbleTea libraries
📝 Documentation-Driven - Use annotations to define your CLI structure
🚀 Focus on Logic - Write your functions, let Charmer handle the UI

🚀 Quick Start

Installation

go get github.com/ImGajeed76/charmer/pkg/charmer@latest

Setup Your Project

Create your main.go:

//go:generate go run github.com/ImGajeed76/charmer/tools/generate

package main

import (
	"your-project/internal/registry"
	"github.com/ImGajeed76/charmer/pkg/charmer"
)

func main() {
	charmer.Run(registry.RegisteredCharms)
}

Run the Generate command:

go generate

If you didn't already create a charms directory, the generate command will create one for you with a sample greeting.go file.

Build & Run

Generate the TUI code:

go generate

Run your application:

go run main.go

Or build an executable:

go build

For detailed usage instructions and examples, visit our documentation.

🎨 How It Works

Charmer uses a annotation-based approach to create TUIs:

Add @Charm annotations to your functions
Define titles and descriptions using @Title and @Description (Descriptions can be multiline)
Run go generate to create the TUI structure
Charmer handles the rest - navigation, UI rendering, and execution

📁 Project Structure

your-project/
├── main.go
└── charms/
    ├── greeting.go
    └── other_commands.go

🛠️ Development Status

⚠️ Early Alpha Stage

This project is currently in early development. Features and APIs may change significantly. The current version might not be fully functional as package publishing is still being configured.

📝 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

💖 Acknowledgments

Built with ❤️ in Switzerland by ImGajeed76
Powered by the amazing Charm libraries

🌟 Purpose: Simplifying the creation of beautiful terminal utility applications, one function at a time.

⚠️ Note: This is an alpha release. Expect changes and improvements as the project evolves.

Need help? Check our documentation or open an issue on GitHub.

charmer