Modèle de script Shell

Un modèle de script Bash moderne avec sortie colorisée et fonctions utilitaires pour créer des outils en ligne de commande professionnels.

Fonctionnalités

• 🎨 Sortie colorisée : Schémas de couleurs et fonctions de formatage prédéfinis
• 📝 Messages standardisés : Formats cohérents pour les messages d'information, de succès, d'avertissement et d'erreur
• 🔧 Fonctions utilitaires : Fonctions prêtes à l'emploi pour les opérations courantes de script shell
• 📦 Conception modulaire : Fichier de bibliothèque séparé pour une réutilisation facile entre projets
• ⚡ Installation facile : Mécanisme d'inclusion simple pour une utilisation immédiate

Démarrage rapide

1. Clonez ou téléchargez ce modèle
2. Rendez votre script exécutable :
   root@kitploit:~

   chmod +x script.sh
   

3. Exécutez le script d'exemple :
   root@kitploit:~

   ./script.sh
   

Utilisation

Structure de base du modèle

#!/bin/bash

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

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

Fonctions disponibles

Types de messages

• info "message" - Affiche les messages d'information avec le préfixe cyan [i]
• ok "message" - Affiche les messages de succès avec le préfixe vert [+]
• warn "message" - Affiche les messages d'avertissement avec le préfixe jaune [!]
• error "message" - Affiche les messages d'erreur avec le préfixe rouge [-] (envoyé sur stderr)

Fonctions interactives

• prompt "question" - Affiche une invite avec le préfixe magenta [?] et attend la saisie de l'utilisateur
• section "title" - Crée un en-tête de section formaté

Formatage du texte

• bold "text" - Affiche le texte en gras

Constantes de couleur

Les constantes de couleur suivantes sont disponibles pour un formatage personnalisé :

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'

Exemple de sortie

Lorsque vous exécutez le script d'exemple, vous verrez :

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

Structure des fichiers

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

Personnalisation

Ajout de nouveaux types de messages

Vous pouvez étendre la bibliothèque en ajoutant de nouveaux types de messages dans lib/format.sh :

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

Couleurs personnalisées

Définissez vos propres schémas de couleurs en modifiant les constantes de couleur ou en créant de nouvelles :

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

Bonnes pratiques

1. Incluez toujours la bibliothèque : Ajoutez source $LIB/format.sh au début de vos scripts
2. Utilisez les types de messages appropriés : Choisissez la bonne fonction selon le contexte (info, ok, warn, error)
3. Structurez avec des sections : Utilisez section pour organiser la sortie de votre script
4. Gérez les erreurs correctement : Utilisez error pour les messages d'erreur et redirigez vers stderr
5. Rendez les scripts exécutables : N'oubliez pas chmod +x pour vos scripts

Contribution

N'hésitez pas à soumettre des problèmes, à forker le dépôt et à créer des demandes de tirage pour toute amélioration.

Licence

Ce projet est sous licence MIT - voir le fichier LICENSE pour plus de détails.

Auteur

Créé par Christoph Huy