Plantilla de Script de Shell

Una plantilla moderna de scripts Bash con formato de salida coloreado y funciones de utilidad para crear herramientas profesionales de línea de comandos.

Características

• 🎨 Salida Coloreada: Esquemas de color predefinidos y funciones de formato
• 📝 Mensajes Estandarizados: Formatos de mensaje consistentes para info, éxito, advertencia y error
• 🔧 Funciones de Utilidad: Funciones listas para usar para operaciones comunes de scripts shell
• 📦 Diseño Modular: Archivo de librería separado para facilitar la reutilización entre proyectos
• ⚡ Configuración Sencilla: Mecanismo simple de sourcing para uso inmediato

Inicio Rápido

1. Clona o descarga esta plantilla
2. Haz ejecutable tu script:
   root@kitploit:~

   chmod +x script.sh
   

3. Ejecuta el script de ejemplo:
   root@kitploit:~

   ./script.sh
   

Uso

Estructura Básica de la Plantilla

#!/bin/bash

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

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

Funciones Disponibles

Tipos de Mensaje

• info "message" - Muestra mensajes informativos con el prefijo cian [i]
• ok "message" - Muestra mensajes de éxito con el prefijo verde [+]
• warn "message" - Muestra mensajes de advertencia con el prefijo amarillo [!]
• error "message" - Muestra mensajes de error con el prefijo rojo [-] (enviados a stderr)

Funciones Interactivas

• prompt "question" - Muestra un prompt con el prefijo magenta [?] y espera la entrada del usuario
• section "title" - Crea un encabezado de sección con formato

Formato de Texto

• bold "text" - Muestra el texto en formato negrita

Constantes de Color

Las siguientes constantes de color están disponibles para formato personalizado:

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'

Ejemplo de Salida

Cuando ejecutes el script de ejemplo, verás:

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

Estructura de Archivos

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

Personalización

Añadir Nuevos Tipos de Mensaje

Puedes ampliar la librería añadiendo nuevos tipos de mensaje en lib/format.sh:

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

Colores Personalizados

Define tus propios esquemas de color modificando las constantes de color o creando nuevas:

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

Buenas Prácticas

1. Siempre incluye la librería: Incluye source $LIB/format.sh al comienzo de tus scripts
2. Usa los tipos de mensaje adecuados: Elige la función correcta según el contexto (info, ok, warn, error)
3. Estructura con secciones: Usa section para organizar la salida de tu script
4. Maneja los errores correctamente: Usa error para mensajes de error y redirige a stderr
5. Haz ejecutables los scripts: No olvides chmod +x para tus scripts

Contribuciones

No dudes en enviar issues, hacer fork del repositorio y crear pull requests para cualquier mejora.

Licencia

Este proyecto está licenciado bajo la Licencia MIT; consulta el archivo LICENSE para más detalles.

Autor

Creado por Christoph Huy