Crate supercli

Crate supercli 

Source
Expand description

§SuperCLI

Universal CLI Management Platform supporting Multiple Popular Languages - Built on starbase-styles foundation with enterprise-grade CLI patterns for output, help, prompts, and more.

SuperCLI wraps starbase-styles to provide consistent, semantic CLI output patterns across all your command-line tools while maintaining full compatibility with the underlying starbase styling system.

Following the SuperConfig approach, SuperCLI is designed to become the universal CLI styling standard across popular languages through WebAssembly bindings, REST APIs, and protocol standardization.

§🚀 Why SuperCLI?

While starbase-styles provides excellent terminal styling, modern CLI applications need more:

  • Consistent output patterns across all CLI tools with semantic functions
  • Fine-grained styling control with the styled! macro
  • Output mode management (color/monochrome/none) with environment variable support
  • Theme-aware output that automatically adapts to light/dark terminals
  • 100% starbase-styles compatibility with enhanced convenience methods

§🎯 Core Features

§🎨 Semantic CLI Output Macros

  • success!() - Success messages with checkmarks
  • warning!() - Warning messages with caution symbols
  • info!() - Informational messages with info symbols
  • error!() - Error messages with error symbols

§🎯 Fine-Grained Styling Control

  • styled!() - Mix different styles within a single line
  • Support for unlimited styling parameters
  • Automatic output mode adaptation

§🎛️ Output Mode Management

  • GUARDY_OUTPUT_STYLE: color, monochrome, none
  • NO_COLOR standard compliance
  • Theme-aware color selection

§Quick Start

use supercli::prelude::*;

// Semantic output macros
success!("Operation completed successfully!");
warning!("This action cannot be undone");
info!("Processing files...");
error!("Configuration file not found");

// Fine-grained styling control
styled!(
    "Processing {} files in {}",
    ("150", "number"),
    ("/home/user", "file_path")
);

// Use starbase-styles functions directly
println!("Found {}", file("config.toml"));

§Advanced Usage

§Multiple Styles in One Line

use supercli::prelude::*;

// Mix multiple styled components
styled!(
    "{} Found {} secrets in {} files ({})",
    ("🔍", "info_symbol"),
    ("5", "error_count"),
    ("127", "file_count"),
    ("2.3s", "duration")
);

§Environment Variable Control

# Disable colors completely
export NO_COLOR=1

# Force monochrome output
export GUARDY_OUTPUT_STYLE=monochrome

# Disable all output styling
export GUARDY_OUTPUT_STYLE=none

§Integration with Clap

ⓘ
use supercli::clap::create_help_styles;
use clap::Parser;

#[derive(Parser)]
#[command(styles = create_help_styles())]
struct Cli {
    #[arg(short, long)]
    verbose: bool,
}

§Semantic Style Types

SuperCLI supports all starbase-styles semantic types and adds CLI-specific ones:

  • Status: success, warning, error, info
  • Data: number, file_path, url, email
  • UI: property, value, symbol, muted
  • Code: id, hash, token
  • And many more…

§Features

  • Zero-dependency core: Only requires starbase-styles
  • Optional clap integration: Enable with clap feature
  • Environment aware: Respects NO_COLOR and custom style variables
  • Cross-platform: Works on Windows, macOS, and Linux
  • Performance focused: Minimal runtime overhead

Re-exports§

pub use output::macros::error_impl;
pub use output::macros::info_impl;
pub use output::macros::success_impl;
pub use output::macros::warning_impl;
pub use output::styling::apply_style;
pub use starbase_styles;

Modules§

output
Output management module
prelude
SuperCLI Prelude

Macros§

error
Print an error message with optional custom symbol
info
Print an info message with optional custom symbol
styled
Print styled text with symbol replacement and fine-grained control
success
Print a success message with optional custom symbol
warning
Print a warning message with optional custom symbol