ConsoleKit 1.0.0

ConsoleKit

ConsoleKit is a professional, feature-rich console helper library for .NET 8+. Stop writing boilerplate formatting code — ConsoleKit gives you beautiful, themed output in minutes.

✨ Features

📦 Installation

dotnet add package ConsoleKit

🚀 Quick Start

using ConsoleKit;

CK.Header("My App", "Version 1.0");

CK.Ok("Server started on port 8080");
CK.Warn("Config file not found — using defaults");
CK.Error("Database connection failed");

// Progress bar
using var pb = CK.Progress(100, "Downloading");
for (int i = 0; i <= 100; i++) { pb.Report(i); Thread.Sleep(30); }
pb.Complete("Done!");

// Spinner
using var spin = CK.Spin("Connecting…");
await ConnectAsync();
spin.Complete("Connected!");

// Table
CK.Table("Name", "City", "Score")
    .WithTitle("Leaderboard")
    .WithRowNumbers()
    .AddRow("Alice", "Berlin", "98")
    .AddRow("Bob",   "Munich", "87")
    .Write();

// Prompt
string name    = CK.AskRequired("Your name");
bool confirmed = CK.Confirm("Continue?", defaultYes: true);
int choice     = CK.Select("Pick a mode", "Fast", "Balanced", "Thorough");

🎨 Themes

using ConsoleKit.Themes;

CK.Theme = ConsoleTheme.Default;      // cyan/blue (default)
CK.Theme = ConsoleTheme.Retro;        // classic green terminal
CK.Theme = ConsoleTheme.HighContrast; // accessibility

// Custom theme
CK.Theme = new ConsoleTheme
{
    Success      = ConsoleColor.Green,
    Error        = ConsoleColor.Red,
    ProgressFill = ConsoleColor.Magenta,
    // … all colors individually configurable
};

📊 Progress Bar Styles

using ConsoleKit.Progress;

using var pb = CK.Progress(100, "Loading", ProgressBarStyle.Default);
using var pb = CK.Progress(100, "Loading", ProgressBarStyle.Smooth);
using var pb = CK.Progress(100, "Loading", ProgressBarStyle.Block);
using var pb = CK.Progress(100, "Loading", ProgressBarStyle.Slim);

// Custom style
var myStyle = new ProgressBarStyle
{
    Fill = '▓', Empty = '░', Left = '|', Right = '|',
    Width = 50, ShowPercent = true, ShowEta = true
};

🔄 Spinner Styles

using ConsoleKit.Progress;

using var s = CK.Spin("Working…", SpinnerStyle.Dots);
using var s = CK.Spin("Working…", SpinnerStyle.Circle);
using var s = CK.Spin("Working…", SpinnerStyle.Arrows);
using var s = CK.Spin("Working…", SpinnerStyle.Clock);

📋 Step Tracker

var steps = CK.Steps("Deployment",
    "Build", "Test", "Publish", "Notify");

steps.Start(0);
await BuildAsync();
steps.Complete(0, "bin/Release");

steps.Start(1);
steps.Fail(1, "2 tests failed");

steps.Skip(2);
steps.Skip(3, "skipped due to failure");

📝 Prompts

string? name  = CK.Ask("Your name", defaultValue: "World");
string  email = CK.AskRequired("Email address");
int     port  = CK.AskInt("Port", min: 1, max: 65535, def: 8080);
string  pass  = CK.AskPassword("Password");
bool    ok    = CK.Confirm("Delete files?");
int     idx   = CK.Select("Environment", "Dev", "Staging", "Prod");
int[]   idxs  = CK.MultiSelect("Features", "Auth", "Logging", "Caching");

CK.PressAnyKey();

📁 Namespace Structure

ConsoleKit
├── CK                          ← Main facade (recommended entry point)
├── Core
│   └── ConsoleWriter           ← Low-level themed output
├── Themes
│   └── ConsoleTheme            ← Theme definitions
├── Progress
│   ├── ProgressBar             ← Determinate progress
│   ├── ProgressBarStyle        ← Visual style for ProgressBar
│   ├── Spinner                 ← Indeterminate spinner
│   ├── SpinnerStyle            ← Built-in animation sequences
│   └── StepTracker             ← Multi-step pipeline display
├── Tables
│   └── ConsoleTable            ← Fluent table builder
└── Prompts
    └── Prompt                  ← User input helpers

📜 License

MIT — see LICENSE file.