Skip to content

Latest commit

 

History

History
141 lines (101 loc) · 6.19 KB

File metadata and controls

141 lines (101 loc) · 6.19 KB

Shell Utils Framework 🐚

pt-BR es en

Shell Utils Logo

Uma Coleção Dinâmica de Scripts Shell com Propósito Educacional

GitHub stars GitHub forks GitHub issues GitHub license

🌟 Visão Geral

O Shell Utils é um framework educacional projetado para tornar a programação shell acessível e poderosa. É o resultado de um trabalho exaustivo de muitos anos, agora disponível no GitHub. Com mais de 400 scripts documentados, atende tanto iniciantes quanto usuários avançados. Seu grande diferencial é a capacidade de interagir com os principais shells: Bash, Zsh e Fish.

Este repositório tem como objetivo estender o shell e conter funções úteis e legíveis que ajudam os desenvolvedores a manter seus scripts de forma mais fácil e organizada.

✅ Inclui scripts de terceiros, como os do Fred's Imagemagick (créditos mantidos nos scripts).

✨ Características Principais

  • Reconhecimento dinâmico de scripts, funções, variáveis e aliases
  • Documentação abrangente e menus de ajuda
  • Compatibilidade entre shells (fish, zsh, bash)
  • Rica coleção de scripts utilitários
  • Recursos educacionais e tutoriais
  • Estrutura de pastas persistente para customizações do usuário que não são afetadas pelas atualizações do framework

📌 O script help_shell lista funções como docker_help (para auxiliar no uso do docker), fornecendo tutoriais rápidos sobre comandos do Linux. Para criar uma função simples, basta criar um arquivo função.sh e armazená-lo em ~/.local/shell_utils/scripts/helps/. O script help_shell será capaz de lê-los e mostrar uma lista completa de funções pedagógicas e muito mais.

📁 Estrutura de Diretórios

~/.shell_utils/
├── scripts/     # Scripts principais
│   ├── faqs/    # Scripts de tutorial e guias
│   └── helps/   # Funções auxiliares educacionais
├── functions/   # Funções personalizadas
├── variables/   # Variáveis de ambiente
└── aliases/     # Aliases do shell

🛡️ Estrutura Persistente para Usuários

Para garantir que suas customizações sejam preservadas durante as atualizações automáticas do framework, utilize a estrutura de diretórios persistente:

~/.local/shell_utils/
├── functions/   # Suas funções personalizadas (seguras contra atualizações)
├── variables/   # Suas variáveis de ambiente personalizadas
├── aliases/     # Seus aliases personalizados
├── priority/    # Scripts com prioridade de carregamento
└── scripts/
    ├── utils/   # Seus scripts utilitários
    └── helps/
        └── markdowns/  # Sua documentação personalizada

🔄 Como Funciona:

  • ~/.shell_utils/ - Framework principal (atualizável via Git)
  • ~/.local/shell_utils/ - Suas customizações (persistentes e seguras)
  • Ordem de Carregamento: Primeiro o framework, depois suas customizações
  • Atualizações Automáticas: Seus arquivos em ~/.local/shell_utils/ nunca são sobrescritos

💡 Para Adicionar Suas Customizações:

# Suas funções personalizadas
vim ~/.local/shell_utils/functions/minha_funcao.sh

# Seus aliases personalizados  
vim ~/.local/shell_utils/aliases/meus_aliases.sh

# Suas variáveis de ambiente
vim ~/.local/shell_utils/variaveis/minhas_variaveis.sh

🔧 Recursos e Ferramentas

  • Alarme: Alarme multilíngue, com capacidade de executar comandos externos, função soneca e muito mais.
  • Leitor de Markdown: Um leitor aprimorado de marcação combinando formatação limpa com destaque de sintaxe opcional.
  • Calendário: Calendário completo com suporte a feriados
  • Ferramentas de Video: Gravador de tela e gerenciadores de videos
  • Ferramentas de Áudio: Gerar frequências de áudio e gerenciares de som
  • Ferramentas de Processamento de Imagem: Converter, redimensionar e manipular imagens
  • Gerenciamento de Temas:
    • Temas do GRUB
    • Temas do Terminal
    • Coleções de arte ASCII
  • Utilitários de Cores:
    • Paleta de cores ANSI
    • Conversor de Hex para ANSI
  • Ferramentas para Gerenciadores de Janelas: Suporte para i3, awesome, openbox e outros
  • Integração com Ferramentas de Terceiros: Incluindo scripts do "Fred's Imagemagick"

🚀 Instalação

Opção 1: Instalação em Uma Linha

bash -c "$(curl -fsSL https://raw.githubusercontent.com/felipefacundes/shell_utils/refs/heads/main/install.sh)"

Opção 2: Instalação Manual

git clone https://github.com/felipefacundes/shell_utils ~/.shell_utils
bash ~/.shell_utils/install.sh

🔄 Dependências

O instalador detecta automaticamente seu shell (fish, zsh ou bash) e instala as dependências necessárias:

  • Para usuários bash: oh-my-bash
  • Para usuários zsh: oh-my-zsh

🤝 Contribuindo

Contribuições são bem-vindas! Sinta-se à vontade para enviar um Pull Request. Para mudanças importantes, por favor, abra uma issue primeiro para discutir o que você gostaria de mudar.

📜 Licença

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

👏 Créditos


Feito com ❤️ pela comunidade Shell Utils

Reportar Bug · Solicitar Recurso