Bui - Unified CLI for Base Stack

A modern, unified CLI tool for Base Stack development. Generate backend modules (Go) and frontend modules (Nuxt/TypeScript) with a single tool, powered by Mamba.

Features

• Unified Interface: Single CLI for both backend and frontend generation
• Backend Generation: Go modules with models, services, controllers, and validators
• Frontend Generation: Nuxt modules with TypeScript types, Pinia stores, Vue components, and pages
• Modern UX: Powered by Mamba for enhanced terminal features (colors, spinners, progress bars)
• Smart Conventions: Automatically infers field types and relationships

Prerequisites

Before installing Bui, ensure you have:

Backend Development

• Go 1.21+ - Install Go
• Image Processing Libraries (required for media handling):
  • macOS: brew install webp libheif
  • Ubuntu/Debian: sudo apt install libwebp-dev libheif-dev
• PostgreSQL (or another database)

Frontend Development

• Node.js 18+ - Install Node.js
• Bun (recommended) - Fast JavaScript runtime:
  • macOS/Linux: curl -fsSL https://bun.sh/install | bash
  • Windows: powershell -c "irm bun.sh/install.ps1 | iex"
  • Verify: bun --version

Installation

curl -fsSL https://raw.githubusercontent.com/base-al/bui/refs/heads/main/install.sh | bash

Installation modes:

• Non-interactive (piped): Installs to ~/.base/bin (requires adding to PATH)
• Interactive (download & run): Choose local or global (/usr/local/bin with sudo)

Alternative - Install via Go:

go install github.com/base-al/bui@latest

Download Binary

Download pre-built binaries from GitHub Releases for your platform:

• macOS (darwin_amd64, darwin_arm64)
• Linux (linux_amd64, linux_arm64)
• Windows (windows_amd64, windows_arm64)

Usage

Generate Backend Module (Go)

# Generate a backend module with API endpoints
bui generate backend product name:string price:float stock:int description:text

# Short aliases
bui g be product name:string price:float
bui g api product name:string price:float

Generates:

• app/models/product.go - GORM model
• app/products/service.go - Business logic
• app/products/controller.go - HTTP handlers
• app/products/module.go - Module registration
• app/products/validator.go - Input validation

Generate Frontend Module (Nuxt/TypeScript)

# Generate a frontend module with UI
bui generate frontend product name:string price:float stock:int description:text

# Short aliases
bui g fe product name:string price:float
bui g ui product name:string price:float

Generates:

• admin/app/modules/products/types/product.ts - TypeScript interfaces
• admin/app/modules/products/stores/products.ts - Pinia store with CRUD
• admin/app/modules/products/components/ProductTable.vue - Data table
• admin/app/modules/products/components/ProductFormModal.vue - Form modal
• admin/app/modules/products/utils/formatters.ts - Formatting utilities
• admin/app/pages/app/products/index.vue - List page
• admin/app/pages/app/products/[id].vue - Detail page

Supported Field Types

Basic Types

• string - Text field
• text - Textarea field
• int, uint - Integer numbers
• float, float32, float64 - Decimal numbers
• bool - Boolean/checkbox

Smart Field Detection

The CLI intelligently detects field purposes by name:

• email - Email input
• password - Password input
• url, link - URL input
• description, content, bio - Textarea
• status, category, type - Select dropdown

BASE

Bui uses base framework for api, check base.al/docs

Other Commands

# Show version
bui version

# Start the application (backend)
bui start

Why Mamba?

Bui uses Mamba, a modern drop-in replacement for Cobra with:

• 100% Cobra API compatibility
• Enhanced terminal UX (colors, spinners, progress bars)
• Built on Charm libraries
• No breaking changes when migrating

Project Structure

bui/
├── commands/          # CLI commands
│   ├── backend/       # Backend generation
│   ├── frontend/      # Frontend generation
│   ├── generate.go    # Generate command router
│   ├── root.go        # Root command
│   ├── start.go       # Start command
│   └── version.go     # Version command
├── utils/             # Utilities and templates
├── version/           # Version management
├── go.mod
├── main.go
└── README.md

Development

# Install dependencies
go mod tidy

# Build
go build -o bui

# Run
./bui --help

Version

Current version: 0.1.0

License

MIT