Template de Script Shell

Um template moderno de script Bash com formatação colorida e funções utilitárias para criar ferramentas de linha de comando profissionais.

Funcionalidades

• 🎨 Saída Colorida: Esquemas de cores predefinidos e funções de formatação
• 📝 Mensagens Padronizadas: Formatos consistentes de mensagens de informação, sucesso, aviso e erro
• 🔧 Funções Utilitárias: Funções prontas para uso para operações comuns de script shell
• 📦 Design Modular: Arquivo de biblioteca separado para fácil reutilização entre projetos
• ⚡ Configuração Simples: Mecanismo simples de source para uso imediato

Início Rápido

1. Clone ou baixe este template
2. Torne seu script executável:
   root@kitploit:~

   chmod +x script.sh
   

3. Execute o script de exemplo:
   root@kitploit:~

   ./script.sh
   

Uso

Estrutura Básica do Template

#!/bin/bash

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

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

Funções Disponíveis

Tipos de Mensagem

• info "mensagem" - Exibe mensagens informativas com prefixo ciano [i]
• ok "mensagem" - Exibe mensagens de sucesso com prefixo verde [+]
• warn "mensagem" - Exibe mensagens de aviso com prefixo amarelo [!]
• error "mensagem" - Exibe mensagens de erro com prefixo vermelho [-] (enviado para stderr)

Funções Interativas

• prompt "pergunta" - Exibe um prompt com prefixo magenta [?] e aguarda a entrada do usuário
• section "título" - Cria um cabeçalho de seção formatado

Formatação de Texto

• bold "texto" - Exibe texto em negrito

Constantes de Cor

As seguintes constantes de cor estão disponíveis para formatação personalizada:

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'

Exemplo de Saída

Ao executar o script de exemplo, você verá:

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

Estrutura de Arquivos

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

Personalização

Adicionando Novos Tipos de Mensagem

Você pode estender a biblioteca adicionando novos tipos de mensagem em lib/format.sh:

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

Cores Personalizadas

Defina seus próprios esquemas de cores modificando as constantes de cor ou criando novas:

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

Melhores Práticas

1. Sempre faça source da biblioteca: Inclua source $LIB/format.sh no início dos seus scripts
2. Use tipos de mensagem apropriados: Escolha a função certa para o contexto (info, ok, warn, error)
3. Estruture com seções: Use section para organizar a saída do script
4. Trate erros adequadamente: Use error para mensagens de erro e redirecione para stderr
5. Torne os scripts executáveis: Não se esqueça do chmod +x para seus scripts

Contribuindo

Sinta-se à vontade para enviar issues, bifurcar o repositório e criar pull requests para quaisquer melhorias.

Licença

Este projeto está licenciado sob a Licença MIT - consulte o arquivo LICENSE para obter detalhes.

Autor

Criado por Christoph Huy