Skip to content

Commit d9dc84e

Browse files
authored
A Dynamic Collection of Shell Scripts with Educational Purpose
Shell Utils is an educational framework designed to make shell programming accessible and powerful. It is the result of extensive work over many years, now available on GitHub. With over 280 documented scripts, it caters to both beginners and advanced users. Its main differentiator is the ability to interact with the major shells: Bash, Zsh, and Fish
1 parent 5440fcb commit d9dc84e

File tree

2 files changed

+206
-0
lines changed

2 files changed

+206
-0
lines changed

README_es.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Shell Utils Framework 🐚
2+
3+
[![pt-BR](https://img.shields.io/badge/lang-pt--BR-green.svg)](./README_pt.md) [![es](https://img.shields.io/badge/lang-es-yellow.svg)](./README_es.md) [![en](https://img.shields.io/badge/lang-en-red.svg)](./README.md)
4+
5+
<div align="center">
6+
7+
![Shell Utils Logo](./icons/logo.png)
8+
9+
*Una Colección Dinámica de Scripts Shell con Propósito Educacional*
10+
11+
![GitHub stars](https://img.shields.io/github/stars/felipefacundes/shell_utils?style=social)
12+
![GitHub forks](https://img.shields.io/github/forks/felipefacundes/shell_utils?style=social)
13+
![GitHub issues](https://img.shields.io/github/issues/felipefacundes/shell_utils)
14+
![GitHub license](https://img.shields.io/github/license/felipefacundes/shell_utils)
15+
16+
</div>
17+
18+
## 🌟 Visión General
19+
20+
Shell Utils es un marco educativo diseñado para hacer que la programación en shell sea accesible y poderosa. Es el resultado de un trabajo exhaustivo durante muchos años, ahora disponible en GitHub. Con más de 280 scripts documentados, atiende tanto a principiantes como a usuarios avanzados. Su gran diferenciador es la capacidad de interactuar con los principales shells: **Bash, Zsh y Fish**.
21+
22+
✅ Incluye scripts de terceros, como los de [Fred's Imagemagick](http://www.fmwconcepts.com/imagemagick/index.php) *(créditos mantenidos en los scripts)*.
23+
24+
### ✨ Características Principales
25+
26+
- Reconocimiento dinámico de scripts, funciones, variables y alias
27+
- Documentación completa y menús de ayuda
28+
- Compatibilidad entre shells (fish, zsh, bash)
29+
- Rica colección de scripts utilitarios
30+
- Recursos educativos y tutoriales
31+
32+
📌 El script `help_shell` lista funciones como `sed_info` (para ayudar con el uso de sed), proporcionando tutoriales rápidos sobre comandos de Linux. Para crear una función simple, solo crea un archivo `función.sh` y guárdalo en `~/.shell_utils/scripts/helps/`. El script `help_shell` podrá leerlos y mostrar una lista completa de funciones pedagógicas y mucho más.
33+
34+
## 📁 Estructura de Directorios
35+
36+
```bash
37+
~/.shell_utils/
38+
├── scripts/ # Scripts principales
39+
│ ├── faqs/ # Scripts de tutorial y guías
40+
│ └── helps/ # Funciones auxiliares educativas
41+
├── functions/ # Funciones personalizadas
42+
├── variables/ # Variables de entorno
43+
└── aliases/ # Alias del shell
44+
```
45+
46+
## 🔧 Recursos y Herramientas
47+
48+
- **Alarma**: Alarma multilingüe, con capacidad de ejecutar comandos externos, función de repetición y más.
49+
- **Calendario**: Calendario completo con soporte para días festivos
50+
- **Herramientas de Video**: Grabador de pantalla y administradores de videos
51+
- **Herramientas de Audio**: Generar frecuencias de audio y administradores de sonido
52+
- **Herramientas de Procesamiento de Imágenes**: Convertir, redimensionar y manipular imágenes
53+
- **Gestión de Temas**:
54+
- Temas de GRUB
55+
- Temas de Terminal
56+
- Colecciones de arte ASCII
57+
- **Utilidades de Color**:
58+
- Paleta de colores ANSI
59+
- Convertidor de Hex a ANSI
60+
- **Herramientas para Gestores de Ventanas**: Soporte para i3, awesome, openbox y otros
61+
- **Integración con Herramientas de Terceros**: Incluyendo scripts de ["Fred's Imagemagick"](http://www.fmwconcepts.com/imagemagick/index.php)
62+
63+
## 🚀 Instalación
64+
65+
### Opción 1: Instalación en Una Línea
66+
```bash
67+
bash -c "$(curl -fsSL https://raw.githubusercontent.com/felipefacundes/shell_utils/refs/heads/main/install.sh)"
68+
```
69+
70+
### Opción 2: Instalación Manual
71+
```bash
72+
git clone https://github.com/felipefacundes/shell_utils ~/.shell_utils
73+
bash ~/.shell_utils/install.sh
74+
```
75+
76+
## 🔄 Dependencias
77+
78+
El instalador detecta automáticamente tu shell (fish, zsh o bash) e instala las dependencias necesarias:
79+
- Para usuarios de bash: oh-my-bash
80+
- Para usuarios de zsh: oh-my-zsh
81+
82+
## 🤝 Contribuyendo
83+
84+
¡Las contribuciones son bienvenidas! Siéntete libre de enviar un Pull Request. Para cambios importantes, por favor abre un issue primero para discutir lo que te gustaría cambiar.
85+
86+
## 📜 Licencia
87+
88+
Este proyecto está licenciado bajo la Licencia GPLv3 - consulta el archivo [LICENSE](LICENSE) para obtener detalles.
89+
90+
## 👏 Créditos
91+
92+
- Creador original: [Felipe Facundes](https://github.com/felipefacundes)
93+
- Agradecimientos especiales a todos los contribuyentes y a [Fred's Imagemagick](http://www.fmwconcepts.com/imagemagick/index.php) por algunos scripts incluidos
94+
95+
---
96+
97+
<div align="center">
98+
99+
**Hecho con ❤️ por la comunidad Shell Utils**
100+
101+
[Reportar Bug](https://github.com/felipefacundes/shell_utils/issues) · [Solicitar Recurso](https://github.com/felipefacundes/shell_utils/issues)
102+
103+
</div>

README_pt.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Shell Utils Framework 🐚
2+
3+
[![pt-BR](https://img.shields.io/badge/lang-pt--BR-green.svg)](./README_pt.md) [![es](https://img.shields.io/badge/lang-es-yellow.svg)](./README_es.md) [![en](https://img.shields.io/badge/lang-en-red.svg)](./README.md)
4+
5+
<div align="center">
6+
7+
![Shell Utils Logo](./icons/logo.png)
8+
9+
*Uma Coleção Dinâmica de Scripts Shell com Propósito Educacional*
10+
11+
![GitHub stars](https://img.shields.io/github/stars/felipefacundes/shell_utils?style=social)
12+
![GitHub forks](https://img.shields.io/github/forks/felipefacundes/shell_utils?style=social)
13+
![GitHub issues](https://img.shields.io/github/issues/felipefacundes/shell_utils)
14+
![GitHub license](https://img.shields.io/github/license/felipefacundes/shell_utils)
15+
16+
</div>
17+
18+
## 🌟 Visão Geral
19+
20+
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 280 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**.
21+
22+
✅ Inclui scripts de terceiros, como os do [Fred's Imagemagick](http://www.fmwconcepts.com/imagemagick/index.php) *(créditos mantidos nos scripts)*.
23+
24+
### ✨ Características Principais
25+
26+
- Reconhecimento dinâmico de scripts, funções, variáveis e aliases
27+
- Documentação abrangente e menus de ajuda
28+
- Compatibilidade entre shells (fish, zsh, bash)
29+
- Rica coleção de scripts utilitários
30+
- Recursos educacionais e tutoriais
31+
32+
📌 O script `help_shell` lista funções como `sed_info` (para auxiliar no uso do sed), 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 `~/.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.
33+
34+
## 📁 Estrutura de Diretórios
35+
36+
```bash
37+
~/.shell_utils/
38+
├── scripts/ # Scripts principais
39+
│ ├── faqs/ # Scripts de tutorial e guias
40+
│ └── helps/ # Funções auxiliares educacionais
41+
├── functions/ # Funções personalizadas
42+
├── variables/ # Variáveis de ambiente
43+
└── aliases/ # Aliases do shell
44+
```
45+
46+
## 🔧 Recursos e Ferramentas
47+
48+
- **Alarme**: Alarme multilíngue, com capacidade de executar comandos externos, função soneca e muito mais.
49+
- **Calendário**: Calendário completo com suporte a feriados
50+
- **Ferramentas de Video**: Gravador de tela e gerenciadores de videos
51+
- **Ferramentas de Áudio**: Gerar frequências de áudio e gerenciares de som
52+
- **Ferramentas de Processamento de Imagem**: Converter, redimensionar e manipular imagens
53+
- **Gerenciamento de Temas**:
54+
- Temas do GRUB
55+
- Temas do Terminal
56+
- Coleções de arte ASCII
57+
- **Utilitários de Cores**:
58+
- Paleta de cores ANSI
59+
- Conversor de Hex para ANSI
60+
- **Ferramentas para Gerenciadores de Janelas**: Suporte para i3, awesome, openbox e outros
61+
- **Integração com Ferramentas de Terceiros**: Incluindo scripts do ["Fred's Imagemagick"](http://www.fmwconcepts.com/imagemagick/index.php)
62+
63+
## 🚀 Instalação
64+
65+
### Opção 1: Instalação em Uma Linha
66+
```bash
67+
bash -c "$(curl -fsSL https://raw.githubusercontent.com/felipefacundes/shell_utils/refs/heads/main/install.sh)"
68+
```
69+
70+
### Opção 2: Instalação Manual
71+
```bash
72+
git clone https://github.com/felipefacundes/shell_utils ~/.shell_utils
73+
bash ~/.shell_utils/install.sh
74+
```
75+
76+
## 🔄 Dependências
77+
78+
O instalador detecta automaticamente seu shell (fish, zsh ou bash) e instala as dependências necessárias:
79+
- Para usuários bash: oh-my-bash
80+
- Para usuários zsh: oh-my-zsh
81+
82+
## 🤝 Contribuindo
83+
84+
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.
85+
86+
## 📜 Licença
87+
88+
Este projeto está licenciado sob a Licença GPLv3 - consulte o arquivo [LICENSE](LICENSE) para obter detalhes.
89+
90+
## 👏 Créditos
91+
92+
- Criador original: [Felipe Facundes](https://github.com/felipefacundes)
93+
- Agradecimentos especiais a todos os contribuidores e ao [Fred's Imagemagick](http://www.fmwconcepts.com/imagemagick/index.php) por alguns scripts incluídos
94+
95+
---
96+
97+
<div align="center">
98+
99+
**Feito com ❤️ pela comunidade Shell Utils**
100+
101+
[Reportar Bug](https://github.com/felipefacundes/shell_utils/issues) · [Solicitar Recurso](https://github.com/felipefacundes/shell_utils/issues)
102+
103+
</div>

0 commit comments

Comments
 (0)