ConsoleKit 1.0.1

<div align="center">

🖥️ ConsoleKit

Professionelle, theme-fähige Konsolenausgabe für .NET — ohne Boilerplate.

  ══════════════════════════════════════════════════════════════════════
                         MEINE ANWENDUNG  v1.0
                    Willkommen beim Deployment-Tool
  ══════════════════════════════════════════════════════════════════════

  ✓  Server erfolgreich gestartet auf http://localhost:5000
  ✗  Datenbankverbindung fehlgeschlagen: Timeout nach 30s
  ⚠  Konfigurationsdatei nicht gefunden — Standardwerte werden verwendet
  ℹ  Nächstes Backup: heute um 02:00 Uhr

  Downloading  [████████████████░░░░░░░░░░░░░░░░░░░░░░░░]  40%  40/100  ETA 0m36s

</div>

Was ist ConsoleKit?

Jeder .NET-Entwickler hat irgendwann dieselbe Datei geschrieben: Eine ConsoleHelper.cs mit hartcodierten Farben, Copy-Paste-Trennlinien und einer WriteError-Methode. ConsoleKit ist die professionelle, fertige Version davon.

ConsoleKit ist eine Zero-Dependency-Bibliothek für .NET 8+, die folgende Probleme löst:

• Formatierung — Trennlinien, zentrierte Überschriften, Einrückungen konsistent über die ganze App
• Farb-Themes — alle Farben zentral definiert, austauschbar zur Laufzeit, keine hardcodierten ConsoleColor-Werte
• Animierter Fortschritt — ProgressBar mit ETA und Throughput, animierter Spinner für unbekannte Dauer
• Pipelines visualisieren — StepTracker zeigt Deployment-Schritte mit Live-Statussymbolen
• Tabellen — Box-Drawing-Zeichen, automatische Spaltenbreite, typsichere Zeilen per Lambda
• User-Prompts — Texteingabe, Passwörter, Zahlen mit Bereichsvalidierung, Menüs, Mehrfachauswahl

Die gesamte Bibliothek ist thread-safe — alle Ausgaben sind synchronisiert, Timer-Callbacks (ProgressBar, Spinner) können gefahrlos parallel zum Hauptthread laufen.

📦 Installation

dotnet add package ConsoleKit

<PackageReference Include="ConsoleKit" Version="1.0.0" />

Voraussetzungen: .NET 8.0 oder höher, keine weiteren Abhängigkeiten.

⚡ Schnellstart

Der einfachste Einstieg ist die statische Facade-Klasse CK. Ein einzelnes using reicht aus:

using ConsoleKit;

// Bildschirm löschen + zentrierte Titelbox
CK.Header("Meine App", "Version 1.0.0");

// Farbige Statusmeldungen
CK.Ok("Verbindung hergestellt");
CK.Error("Fehler beim Laden der Konfiguration");
CK.Warn("Speicher niedrig: noch 200 MB verfügbar");
CK.Info("Nächster Sync in 5 Minuten");

// Schlüssel-Wert-Paare
CK.KeyValue("Umgebung", "Production");
CK.KeyValue("Datenbank", "PostgreSQL 16");

// Trennlinie
CK.Separator();

Wer mehr Kontrolle braucht, kann direkt auf ConsoleWriter, ProgressBar, ConsoleTable usw. zugreifen (siehe Abschnitte unten).

🎨 Themes

Alle Farben in ConsoleKit kommen aus einem einzigen ConsoleTheme-Objekt. Das Theme lässt sich jederzeit — auch mitten im Programmlauf — austauschen.

Eingebaute Themes

using ConsoleKit.Themes;

CK.Theme = ConsoleTheme.Default;       // Cyan/Blau — Standard für dunkle Terminals
CK.Theme = ConsoleTheme.Retro;         // Grün-auf-Schwarz, klassisches Terminal-Feeling
CK.Theme = ConsoleTheme.HighContrast;  // Maximaler Kontrast für Barrierefreiheit

Eigenes Theme

Alle 16 Farbrollen sind einzeln konfigurierbar:

CK.Theme = new ConsoleTheme
{
    Header       = ConsoleColor.White,
    Separator    = ConsoleColor.DarkGray,
    SectionTitle = ConsoleColor.Cyan,
    Success      = ConsoleColor.Green,
    Error        = ConsoleColor.Red,
    Warning      = ConsoleColor.Yellow,
    Info         = ConsoleColor.Cyan,
    Progress     = ConsoleColor.DarkCyan,
    ProgressFill = ConsoleColor.Cyan,
    Prompt       = ConsoleColor.White,
    MenuOption   = ConsoleColor.Yellow,
    TableHeader  = ConsoleColor.Cyan,
    TableRow     = ConsoleColor.Gray,
    TableAlt     = ConsoleColor.DarkGray,
    Muted        = ConsoleColor.DarkGray,
    Highlight    = ConsoleColor.Magenta,
};

📊 ProgressBar

Die ProgressBar läuft auf einem eigenen Hintergrundtimer (100ms) und aktualisiert sich auch ohne explizite Report()-Aufrufe. Sie implementiert IProgress<int> und IDisposable.

  Downloading  [████████████████░░░░░░░░░░░░░░░░░░░░░░░░]  40%  40/100  ETA 0m36s
  Installing   ╠━━━━━━━━━━━━━━━━━━━━━━━━━╌╌╌╌╌╌╌╌╌╌╌╌╌╌╣  77%  77/100  12.3/s

Grundlegende Verwendung

using ConsoleKit.Progress;

// Absoluten Wert melden (0 … total)
using var pb = new ProgressBar(total: 500, label: "Verarbeite Dateien");
for (int i = 0; i <= 500; i++)
{
    pb.Report(i);
    await ProcessFileAsync(i);
}
pb.Complete("Alle Dateien verarbeitet");

// Inkrementell
using var pb = new ProgressBar(100, "Upload");
foreach (var chunk in chunks)
{
    await UploadAsync(chunk);
    pb.Increment();
}
pb.Complete("Upload abgeschlossen");

Als IProgress<int> für bestehende APIs

using var pb = new ProgressBar(100, "Konvertierung");
await converter.RunAsync(progress: pb);  // direkt an APIs übergeben, die IProgress<int> erwarten
pb.Complete();

Visuell-Stile

ProgressBarStyle ist ein record und unterstützt with-Expressions für nicht-destruktive Anpassung:

// Eingebaute Stile
ProgressBarStyle.Default   // [████░░░░]
ProgressBarStyle.Slim      // |▬▬▬─────|
ProgressBarStyle.Block     // ▐■■■□□□□▌
ProgressBarStyle.Smooth    // ╠━━━╌╌╌╌╣

// Anpassung per with-Expression
var myStyle = ProgressBarStyle.Default with
{
    Fill           = '▓',
    Empty          = '░',
    Width          = 50,
    ShowPercent    = true,
    ShowEta        = true,
    ShowThroughput = true   // zeigt z.B. "45.2/s" oder "1.5k/s"
};

Optionen

🔄 Spinner

Der Spinner eignet sich für Operationen mit unbekannter Dauer. Er animiert sich selbst über einen Hintergrundtimer und erlaubt das Aktualisieren der Beschriftung während der Laufzeit.

  ⠋  Verbinde mit Datenbank…
  ✓  Verbunden! (PostgreSQL 16.2)
  ✗  Schema-Validierung fehlgeschlagen

Verwendung

using ConsoleKit.Progress;

// Einfacher Spinner im using-Block
using var spin = new Spinner("Verbinde mit Datenbank…");
var conn = await ConnectAsync();
spin.Complete($"Verbunden! ({conn.ServerVersion})");

// Beschriftung live aktualisieren
using var spin = new Spinner("Initialisierung…");
spin.UpdateLabel("Lade Konfiguration…");
await LoadConfigAsync();
spin.UpdateLabel("Starte Dienste…");
await StartServicesAsync();
spin.Complete("Alle Dienste gestartet");

// Fehler oder Warnung signalisieren
spin.Fail("Verbindung abgelehnt");
spin.Warn("Timeout — Retry in 5s");

Hinweis: Bei Dispose() ohne vorheriges Complete()/Fail()/Warn() zeigt der Spinner ein neutrales –-Symbol statt eines Fehler-Icons.

Animations-Stile

// Eigene Frames und Geschwindigkeit
var spin = new Spinner("Arbeite…", frames: ["◜","◠","◝","◞","◡","◟"], intervalMs: 120);

📋 StepTracker

Der StepTracker visualisiert mehrstufige Prozesse mit live aktualisierten Status-Icons. Jede Zeile wird direkt im Terminal überschrieben — keine endlose Ausgabe, nur ein sauberer Block.

  ──────────────────────────────────────────────────
  Deployment Pipeline
  ──────────────────────────────────────────────────
   1. ✓  Packages wiederherstellen  ← bin/packages
   2. ✓  Quellcode kompilieren
   3. ✗  Unit Tests ausführen  ← 3 Tests fehlgeschlagen
   4. –  Artefakte publizieren  ← übersprungen
   5. –  Benachrichtigung senden  ← übersprungen

Verwendung

using ConsoleKit.Progress;

using var steps = new StepTracker("Deployment Pipeline",
    "Packages wiederherstellen",
    "Quellcode kompilieren",
    "Unit Tests ausführen",
    "Artefakte publizieren",
    "Benachrichtigung senden");

steps.Start(0);
await RestoreAsync();
steps.Complete(0, "312 Pakete installiert");

steps.Start(1);
var build = await BuildAsync();
if (!build.Success)
{
    steps.Fail(1, build.ErrorMessage);
    steps.Skip(2, "übersprungen wegen Fehler");
    steps.Skip(3);
    return;
}
steps.Complete(1);

Methoden im Überblick:

Der optionale note-Parameter erscheint als ← Hinweistext neben dem Schrittnamen.

📐 ConsoleTable

ConsoleTable rendert Tabellen mit Box-Drawing-Zeichen. Spaltenbreiten werden automatisch berechnet. Die API ist fluent — alle Konfigurationsmethoden geben this zurück.

  ╔════╦══════════════════╦═════════════════════╦══════════╦═══════╗
  ║ #  ║ Name             ║ Role                ║ City     ║ Score ║
  ╠════╬══════════════════╬═════════════════════╬══════════╬═══════╣
  ║  1 ║ Alice Müller     ║ Backend Developer   ║ Berlin   ║ 98    ║
  ╟────╫──────────────────╫─────────────────────╫──────────╫───────╢
  ║  2 ║ Bob Schneider    ║ Frontend Developer  ║ Hamburg  ║ 87    ║
  ╟────╫──────────────────╫─────────────────────╫──────────╫───────╢
  ║  3 ║ Clara Fischer    ║ DevOps / Platform…  ║ Munich   ║ 93    ║
  ╚════╩══════════════════╩═════════════════════╩══════════╩═══════╝

Grundlegende Verwendung

using ConsoleKit.Tables;

ConsoleTable.Create("Name", "Stadt", "Punkte")
    .WithTitle("Rangliste")
    .WithRowNumbers()
    .AddRow("Alice", "Berlin", "98")
    .AddRow("Bob",   "München", "87")
    .Write();

Typsichere Zeilen mit Lambdas

var users = await db.Users.ToListAsync();

ConsoleTable.Create("ID", "Name", "E-Mail", "Registriert")
    .WithMaxColumnWidth(30)
    .AddRows(users,
        u => u.Id.ToString(),
        u => u.FullName,
        u => u.Email,
        u => u.CreatedAt.ToString("dd.MM.yyyy"))
    .Write();

Fluent-Konfiguration

💬 Prompts

  ▶ Dein Name [Welt]: Alice
  ▶ Passwort: ******
  ▶ Port (1–65535) [8080]:
  ▶ Deployment starten? [Y/n]:

Texteingabe

// Optional — gibt null zurück wenn leer
string? name = CK.Ask("Dein Name");

// Mit Standardwert — Enter übernimmt den Wert in []
string? host = CK.Ask("Hostname", defaultValue: "localhost");

// Pflichtfeld — wiederholt bis etwas eingegeben wird
string email = CK.AskRequired("E-Mail-Adresse");

// Passwort — Eingabe wird mit * maskiert
string pass = CK.AskPassword("Passwort");

Zahlen

// Integer mit Bereichsvalidierung
int port    = CK.AskInt("Port",    min: 1,   max: 65535, def: 8080);
int timeout = CK.AskInt("Timeout", min: 1,   max: 300,   def: 30);

// Dezimalzahl (InvariantCulture — Punkt als Dezimaltrenner)
double rate = CK.AskDouble("Prozentsatz", min: 0.0, max: 100.0, def: 50.0);

Ungültige Eingaben werden automatisch abgewiesen und die Frage wiederholt.

Bestätigung

bool ok = CK.Confirm("Alle Dateien löschen?");               // Standard: Nein
bool ok = CK.Confirm("Weiter?", defaultYes: true);           // Standard: Ja

Auswahlmenüs

// Einfachauswahl — gibt 0-basierten Index zurück
int choice = CK.Select("Ziel-Umgebung", "Development", "Staging", "Production");

// Mehrfachauswahl — Eingabe: "1,3" oder "all"
int[] features = CK.MultiSelect("Aktiviere Features",
    "Authentifizierung", "Logging", "Caching", "Rate Limiting");

📢 Statusmeldungen & Ausgabe

CK.Ok("Backup erfolgreich abgeschlossen");       // ✓  grün
CK.Error("Verbindung zum Server unterbrochen");  // ✗  rot
CK.Warn("Zertifikat läuft in 7 Tagen ab");      // ⚠  gelb
CK.Info("Neues Update verfügbar: v2.1.0");      // ℹ  cyan
CK.Muted("DEBUG: Config geladen aus app.json"); // →  grau
CK.Highlight("★ Premium-Feature aktiviert");    // ★  magenta

// Struktur
CK.Header("Mein Tool", "Deployment v2.0");      // Bildschirm löschen + Titelbox
CK.Section("Datenbankverbindung");               // Abschnittstitel mit Trennlinien
CK.Separator();                                  // Einfache Trennlinie (─)
CK.Separator('═');                               // Beliebiges Zeichen
CK.KeyValue("Host", "db.example.com");           // Schlüssel: Wert
CK.Blank();                                      // Leerzeile

🏗️ Architektur

ConsoleKit/
├── CK                     ← Statische Facade — empfohlener Einstiegspunkt
├── Core/
│   └── ConsoleWriter      ← Basis-Ausgabe, thread-safe, theme-bewusst
├── Themes/
│   └── ConsoleTheme       ← 16 Farbrollen, 3 eingebaute Themes
├── Progress/
│   ├── ProgressBar        ← IProgress<int> + IDisposable, Hintergrundtimer
│   ├── ProgressBarStyle   ← record mit with-Expression-Support
│   ├── Spinner            ← Indeterminater Spinner, IDisposable
│   ├── SpinnerStyle       ← 8 eingebaute Animationssequenzen
│   └── StepTracker        ← Pipeline-Visualisierung, IDisposable
├── Tables/
│   └── ConsoleTable       ← Fluent Builder, Box-Drawing, Generic-Support
└── Prompts/
    └── Prompt             ← Ask, AskInt, AskDouble, AskPassword, Confirm, Select, MultiSelect

Thread-Safety im Detail

• Alle ConsoleWriter-Methoden sind mit einem gemeinsamen lock-Objekt synchronisiert
• ProgressBar und Spinner rendern auf System.Threading.Timer-Callbacks — der Render-Pfad ist gelockt
• _disposed / _completed / _stopped sind volatile — lesbar über Thread-Grenzen ohne Lock-Overhead
• Cursor-Positionen werden vor jedem Render gespeichert und im finally-Block wiederhergestellt
• Mehrere parallele ProgressBar-Instanzen sind möglich, da jede ihre eigene Terminal-Zeile reserviert

📋 Vollständiges Beispiel

using ConsoleKit;
using ConsoleKit.Progress;
using ConsoleKit.Themes;

CK.Theme = ConsoleTheme.Default;
CK.Header("Deployment Tool", "Production Release v2.0.0");

CK.Section("Konfiguration");
CK.KeyValue("Umgebung", "Production");
CK.KeyValue("Server",   "prod-01.example.com");
CK.KeyValue("Branch",   "main @ a3f9c12");

CK.Blank();
bool proceed = CK.Confirm("Deployment starten?", defaultYes: false);
if (!proceed) { CK.Warn("Abgebrochen."); return; }

using var steps = CK.Steps("Deployment-Pipeline",
    "Abhängigkeiten installieren",
    "Tests ausführen",
    "Docker-Image bauen",
    "Image pushen",
    "Kubernetes aktualisieren",
    "Health Check");

steps.Start(0);
using (var pb = CK.Progress(100, "npm install", ProgressBarStyle.Slim))
{
    for (int i = 0; i <= 100; i++) { pb.Report(i); await Task.Delay(10); }
    pb.Complete();
}
steps.Complete(0, "312 Pakete");

steps.Start(1);
using (var spin = CK.Spin("Teste…", SpinnerStyle.Dots))
{
    await RunTestsAsync();
    spin.Complete("142 Tests bestanden");
}
steps.Complete(1);

// ... weitere Schritte

CK.Table("Schritt", "Dauer", "Status")
    .WithTitle("Zusammenfassung")
    .AddRow("npm install",   "8.2s",  "✓")
    .AddRow("Tests",         "23.1s", "✓")
    .AddRow("Docker build",  "45.7s", "✓")
    .Write();

CK.Ok("Deployment erfolgreich abgeschlossen!");
CK.PressAnyKey();

🤝 Beitragen

Beiträge sind willkommen! Bitte lies zuerst CONTRIBUTING.md.

1. Repository forken
2. Feature-Branch erstellen: git checkout -b feature/mein-feature
3. Änderungen committen: git commit -m 'feat: mein neues Feature'
4. Branch pushen: git push origin feature/mein-feature
5. Pull Request öffnen

📜 Lizenz

Veröffentlicht unter der MIT-Lizenz — siehe LICENSE für Details.

<div align="center">

Mit ❤️ gebaut für .NET-Entwickler, die ihre CLI-Apps professionell aussehen lassen wollen.

NuGet · Dokumentation · Changelog · Issues

</div>