Shell-Skript-Vorlage

Eine moderne Bash-Skript-Vorlage mit farbiger Ausgabeformatierung und Hilfsfunktionen zur Erstellung professioneller Kommandozeilen-Tools.

Funktionen

• 🎨 Farbige Ausgabe: Vordefinierte Farbschemata und Formatierungsfunktionen
• 📝 Standardisierte Meldungen: Einheitliche Formate für Info-, Erfolgs-, Warn- und Fehlermeldungen
• 🔧 Hilfsfunktionen: Einsatzbereite Funktionen für gängige Shell-Skript-Operationen
• 📦 Modulares Design: Separate Bibliotheksdatei zur einfachen Wiederverwendung in Projekten
• ⚡ Einfache Einrichtung: Einfacher Sourcing-Mechanismus für die sofortige Nutzung

Schnellstart

1. Klone oder lade diese Vorlage herunter
2. Mache dein Skript ausführbar:
   root@kitploit:~

   chmod +x script.sh
   

3. Führe das Beispielskript aus:
   root@kitploit:~

   ./script.sh
   

Verwendung

Grundstruktur der Vorlage

#!/bin/bash

LIB="lib"
source $LIB/format.sh

section "Your Script Section"
info "Information message"
ok "Success message" 
warn "Warning message"
error "Error message"

Verfügbare Funktionen

Meldungstypen

• info "message" - Zeigt Informationsmeldungen mit einem cyanfarbenen [i]-Präfix an
• ok "message" - Zeigt Erfolgsmeldungen mit einem grünen [+]-Präfix an
• warn "message" - Zeigt Warnmeldungen mit einem gelben [!]-Präfix an
• error "message" - Zeigt Fehlermeldungen mit einem roten [-]-Präfix an (an stderr gesendet)

Interaktive Funktionen

• prompt "question" - Zeigt eine Eingabeaufforderung mit magenta [?]-Präfix an und wartet auf Benutzereingabe
• section "title" - Erstellt eine formatierte Abschnittsüberschrift

Textformatierung

• bold "text" - Zeigt Text in Fettschrift an

Farbkonstanten

Die folgenden Farbkonstanten stehen für die benutzerdefinierte Formatierung zur Verfügung:

RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
MAGENTA='\033[0;35m'
CYAN='\033[0;36m'
WHITE='\033[1;37m'
BOLD='\033[1m'
UNDERLINE='\033[4m'
RESET='\033[0m'

Beispielausgabe

Wenn du das Beispielskript ausführst, siehst du:

=== Start ===
[i] Running exploit setup...
[+] Everything is ready
[!] This might break your system
[-] Something failed
[?] Continue? [y/N]:

Dateistruktur

shell_template/
├── script.sh          # Example script demonstrating usage
├── lib/
│   └── format.sh       # Core formatting library
├── LICENSE             # MIT License
└── README.md          # This file

Anpassung

Hinzufügen neuer Meldungstypen

Du kannst die Bibliothek erweitern, indem du neue Meldungstypen in lib/format.sh hinzufügst:

DEBUG="${BLUE}[D]${RESET}"
debug() { echo -e "${DEBUG} $*"; }

Benutzerdefinierte Farben

Definiere deine eigenen Farbschemata, indem du die Farbkonstanten änderst oder neue erstellst:

PURPLE='\033[0;35m'
CUSTOM_PREFIX="${PURPLE}[*]${RESET}"
custom() { echo -e "${CUSTOM_PREFIX} $*"; }

Bewährte Vorgehensweisen

1. Binde die Bibliothek immer ein: Füge source $LIB/format.sh am Anfang deiner Skripte hinzu
2. Verwende passende Meldungstypen: Wähle die richtige Funktion für den Kontext (info, ok, warn, error)
3. Gliedere mit Abschnitten: Verwende section, um die Ausgabe deines Skripts zu organisieren
4. Behandle Fehler korrekt: Verwende error für Fehlermeldungen und leite sie an stderr um
5. Mache Skripte ausführbar: Vergiss chmod +x für deine Skripte nicht

Mitwirken

Du kannst gerne Issues einreichen, das Repository forken und Pull Requests für Verbesserungen erstellen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – siehe die Datei LICENSE für Details.

Autor

Erstellt von Christoph Huy