Added new README and also added the Italian Version
This commit is contained in:
@@ -1,230 +1,399 @@
|
||||
# Modular Bashrc Manager
|
||||
<div align="center">
|
||||
|
||||
### A simple, modular, and clean way to manage your `.bashrc` file in Linux.
|
||||
# ⚡ Modular Bashrc Manager
|
||||
|
||||
**A modern, modular, and blazing-fast system to organize, manage, and scale your Bash configuration in Linux & macOS.**
|
||||
|
||||
[](#)
|
||||
[](README.it.md)
|
||||
[](https://www.gnu.org/software/bash/)
|
||||
[](LICENSE)
|
||||
[](https://www.kernel.org/)
|
||||
[](https://gitea.sld-server.org/sld-admin/Modular-Bashrc-Manager)
|
||||
|
||||
[🇬🇧 **English**](README.md) • [🇮🇹 **Italiano**](README.it.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
`Modular Bashrc Manager` is a shell-based system designed to keep your Bash configuration clean, structured, and easy to maintain.
|
||||
Instead of placing everything directly inside `.bashrc`, this project lets you split your configuration into modular scripts that are loaded automatically at shell startup.
|
||||
## 📑 Table of Contents
|
||||
|
||||
The project includes:
|
||||
|
||||
- an automated intelligent installer with OS detection and automatic migration
|
||||
- a command-line management tool (`brc-script`)
|
||||
- a modular directory layout (`scripts-available`, `scripts-enabled`, `scripts-needed`, `scripts-removed`)
|
||||
- default ready-to-use scripts (Git highlights, multi-distro bashboard with Cockpit auto-detection, aliases)
|
||||
- a reusable colored echo utility (`ccecho`)
|
||||
- Gitea update and self-upgrade mechanism
|
||||
|
||||
This makes it easier to add, remove, enable, disable, preview, and maintain shell customizations without turning `.bashrc` into a long and messy file.
|
||||
- [Overview](#-overview)
|
||||
- [Why Modular Bashrc Manager?](#-why-modular-bashrc-manager)
|
||||
- [Key Features](#-key-features)
|
||||
- [Architecture & Loading Flow](#-architecture--loading-flow)
|
||||
- [Installation & Quick Start](#-installation--quick-start)
|
||||
- [Automated Installation](#automated-installation)
|
||||
- [What the Installer Does](#what-the-installer-does)
|
||||
- [CLI Reference (`brc-script`)](#-cli-reference-brc-script)
|
||||
- [Command Cheat Sheet](#command-cheat-sheet)
|
||||
- [Usage Examples](#usage-examples)
|
||||
- [Included Default Modules](#-included-default-modules)
|
||||
- [Creating Custom Modules](#-creating-custom-modules)
|
||||
- [Extra Utilities (`ccecho`)](#-extra-utilities-ccecho)
|
||||
- [Supported Distributions](#-supported-distributions)
|
||||
- [Troubleshooting & FAQ](#-troubleshooting--faq)
|
||||
- [License & Author](#-license--author)
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
## 🔍 Overview
|
||||
|
||||
- **Modular setup**
|
||||
Keep `.bashrc` organized by loading only the scripts you need.
|
||||
**Modular Bashrc Manager** replaces the traditional, chaotic, single-file `~/.bashrc` with a clean, decoupled, and modular architecture inspired by the `available`/`enabled` paradigm used by Debian, Apache, and Nginx.
|
||||
|
||||
- **Intelligent Installer & Migration**
|
||||
Automatically migrates your pre-existing `.bashrc` into `00_default.sh` and enables it, cleans `.bashrc` to only contain the loader, and installs required tools (`jq`, `curl`) matching your Linux distribution.
|
||||
Instead of stuffing hundreds of aliases, functions, exports, and prompt customizations into one monolithic file, you break your shell configuration into distinct, self-contained scripts that can be enabled, disabled, previewed, created, or safely upgraded with a single command.
|
||||
|
||||
- **Multi-Script Management**
|
||||
Enable or disable multiple scripts in a single command using numerical IDs or script names (e.g. `brc-script -d 1 5 12 10` or `brc-script -e 01_git-cli-highlitgh 03_bashboard`).
|
||||
|
||||
- **Quick Script Preview (`cat`)**
|
||||
Inspect script content and line numbers directly from the terminal with `brc-script -p <id|name>` without opening text editors.
|
||||
|
||||
- **Cockpit Auto-Detection**
|
||||
`03_bashboard.sh` automatically detects if Cockpit is installed and running, discovers its listening port dynamically (from `/etc/cockpit/cockpit.conf`, systemd sockets, or 9090), and shows the direct URL.
|
||||
|
||||
- **Gitea Updates & Upgrades**
|
||||
Check for project updates directly from Gitea with `brc-script --update` and upgrade core and standard scripts safely with `brc-script --upgrade` without touching your personal customizations.
|
||||
|
||||
- **Reusable utility functions**
|
||||
Includes `ccecho`, a colored echo helper for cleaner terminal output.
|
||||
```
|
||||
~/.bashrc ──▶ Loader ──▶ ~/.bashrc.d/scripts-needed/ (Core engine & utilities)
|
||||
──▶ ~/.bashrc.d/scripts-enabled/ (Active customizations)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
## 💡 Why Modular Bashrc Manager?
|
||||
|
||||
The installer backs up your existing `.bashrc`, migrates its content into `~/.bashrc.d/scripts-available/00_default.sh`, enables it, and replaces `.bashrc` with a minimal loader block.
|
||||
|
||||
That block sources scripts from the modular directories:
|
||||
|
||||
- `scripts-needed/`
|
||||
Essential logic scripts required for the system to work (`brc-script.sh`, `ccecho.sh`).
|
||||
- `scripts-enabled/`
|
||||
Scripts that should be loaded at shell startup (symlinks to `scripts-available/`).
|
||||
- `scripts-available/`
|
||||
Scripts that are installed and ready to be enabled or customized.
|
||||
- `scripts-removed/`
|
||||
Scripts that were removed and stored as timestamped backups.
|
||||
| Monolithic `~/.bashrc` | With Modular Bashrc Manager |
|
||||
| :--- | :--- |
|
||||
| ❌ Hundreds of lines in a single messy file | ✅ Decoupled single-purpose scripts |
|
||||
| ❌ Hard to debug errors and test changes | ✅ Enable or disable modules instantly (`brc-script -e` / `-d`) |
|
||||
| ❌ Risk of accidentally breaking the whole shell | ✅ Safe symlink-based activation and automatic backups |
|
||||
| ❌ Impossible to share individual snippets | ✅ Modular files ready to share, version-control, or reuse |
|
||||
| ❌ Manually editing files to preview snippets | ✅ Instant terminal preview with line numbering (`brc-script -p`) |
|
||||
|
||||
---
|
||||
|
||||
## Directory Structure
|
||||
## ✨ Key Features
|
||||
|
||||
After installation, the system uses the following layout:
|
||||
- 🚀 **Intelligent Multi-Distro Installer**
|
||||
Auto-detects your operating system package manager (`apt`, `dnf`, `yum`, `pacman`, `zypper`, `apk`, `brew`) and automatically installs required dependencies (`jq`, `curl`).
|
||||
|
||||
- 🔄 **Zero-Loss Safe Migration**
|
||||
Creates a timestamped backup of your current `~/.bashrc` and automatically migrates your pre-existing customizations into `00_default.sh` so you lose **nothing**.
|
||||
|
||||
- ⚡ **Multi-Script Batch Management**
|
||||
Enable, disable, preview, or remove multiple scripts at the same time using either their numeric ID or script name (e.g. `brc-script -e 1 3 4` or `brc-script -d 03_bashboard 04_aliases`).
|
||||
|
||||
- 👁️ **Instant Script Code Preview (`cat`)**
|
||||
View script contents with colored status headers and line numbering without opening an external editor (`brc-script -p <id|name>`).
|
||||
|
||||
- 🖥️ **Smart System Bashboard**
|
||||
Includes `03_bashboard.sh`, a fast MOTD-style dashboard showing CPU, RAM, disk usage, uptime, distro details, IP addresses, package update counts, and **automatic dynamic discovery of Cockpit Web UI**.
|
||||
|
||||
- 🌿 **Git CLI Status Highlighting**
|
||||
Includes dynamic prompt hooks (`01_git-cli-highlitgh.sh` & `02_git-cli-highlitgh-root.sh`) that show current Git branch, staged (`+`), modified (`M:`), untracked (`N:`), and remote sync (`↑`/`↓`) status directly in your prompt.
|
||||
|
||||
- 🔄 **Gitea Updates & Safe Upgrades**
|
||||
Check for official updates with `brc-script -u` and safely upgrade core files with `brc-script --upgrade` without touching personal configurations or `00_default.sh`.
|
||||
|
||||
- 🎨 **Built-in `ccecho` Styling Utility**
|
||||
Lightweight utility for terminal coloring and styling (bold, underline, dim, blink, colors, backgrounds).
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture & Loading Flow
|
||||
|
||||
When your shell starts, `~/.bashrc` executes a minimal loader loop that sources modules in a deterministic order:
|
||||
|
||||
```text
|
||||
~/.bashrc.d/
|
||||
├── .version
|
||||
├── scripts-needed/
|
||||
│ ├── brc-script.sh
|
||||
│ └── ccecho.sh
|
||||
├── scripts-available/
|
||||
│ ├── 00_default.sh
|
||||
│ ├── 01_git-cli-highlitgh.sh
|
||||
│ ├── 02_git-cli-highlitgh-root.sh
|
||||
│ ├── 03_bashboard.sh
|
||||
│ └── 04_aliases.sh
|
||||
├── scripts-enabled/
|
||||
│ └── 00_default.sh -> ~/.bashrc.d/scripts-available/00_default.sh
|
||||
└── scripts-removed/
|
||||
├── .version # Current commit/version tracking hash
|
||||
├── .update_cache # Cache for passive Gitea update checks
|
||||
├── scripts-needed/ # Essential engine scripts (Always loaded first)
|
||||
│ ├── brc-script.sh # Main CLI manager logic & functions
|
||||
│ └── ccecho.sh # Colored terminal printing engine
|
||||
│
|
||||
├── scripts-available/ # All installed scripts (Library of modules)
|
||||
│ ├── 00_default.sh # Your personal migrated config (Protected)
|
||||
│ ├── 01_git-cli-highlitgh.sh # Git branch & status prompt (User)
|
||||
│ ├── 02_git-cli-highlitgh-root.sh # Git branch & status prompt (Root/User color-coded)
|
||||
│ ├── 03_bashboard.sh # System metrics & Cockpit auto-detection
|
||||
│ └── 04_aliases.sh # General utility aliases
|
||||
│
|
||||
├── scripts-enabled/ # Symlinks pointing to active scripts in scripts-available/
|
||||
│ ├── 00_default.sh -> ../scripts-available/00_default.sh
|
||||
│ └── 03_bashboard.sh -> ../scripts-available/03_bashboard.sh
|
||||
│
|
||||
└── scripts-removed/ # Recycle bin with timestamped backups of removed scripts
|
||||
```
|
||||
|
||||
### Loading Order:
|
||||
1. All files in `scripts-needed/*.sh` are sourced sequentially.
|
||||
2. All active symlinks in `scripts-enabled/*.sh` are sourced alphabetically.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
## 📥 Installation & Quick Start
|
||||
|
||||
### Automated Installation
|
||||
|
||||
1. Clone the repository from the official Gitea server:
|
||||
1. **Clone the repository:**
|
||||
```bash
|
||||
git clone https://gitea.sld-server.org/sld-admin/Modular-Bashrc-Manager.git
|
||||
cd Modular-Bashrc-Manager/installer
|
||||
```
|
||||
|
||||
```bash
|
||||
git clone https://gitea.sld-server.org/sld-admin/Modular-Bashrc-Manager
|
||||
cd Modular-Bashrc-Manager/installer
|
||||
```
|
||||
2. **Run the installer:**
|
||||
```bash
|
||||
chmod +x brc-script-install.sh
|
||||
./brc-script-install.sh
|
||||
```
|
||||
|
||||
2. Make the installer executable and run it:
|
||||
3. **Reload your shell:**
|
||||
```bash
|
||||
refresh-brc
|
||||
# or: source ~/.bashrc
|
||||
```
|
||||
|
||||
```bash
|
||||
chmod +x brc-script-install.sh
|
||||
./brc-script-install.sh
|
||||
```
|
||||
> [!TIP]
|
||||
> You can run the installer as a normal user or as `root` to configure any user on the system.
|
||||
|
||||
### What the installer does:
|
||||
- Detects the Linux distribution (`apt`, `dnf`, `yum`, `pacman`, `zypper`, `apk`, `brew`) and automatically installs `jq` and `curl` if missing.
|
||||
- Creates timestamped backup of your current `.bashrc`.
|
||||
- Automatically copies your existing `.bashrc` content into `~/.bashrc.d/scripts-available/00_default.sh` and enables it.
|
||||
- Writes the clean modular loader block to `.bashrc`.
|
||||
- Copies core scripts to `scripts-needed/` and default scripts to `scripts-available/`.
|
||||
- Initializes the `.version` file for future update tracking.
|
||||
|
||||
3. Reload `.bashrc`:
|
||||
|
||||
```bash
|
||||
source ~/.bashrc
|
||||
# or run: refresh-brc
|
||||
```
|
||||
### What the Installer Does:
|
||||
- 🔍 Detects OS distribution and installs `jq` and `curl` automatically.
|
||||
- 💾 Creates a timestamped backup of your current `~/.bashrc` (e.g. `~/bashrc-backup-2026-08-26_16-00-00`).
|
||||
- 🚚 Migrates existing `.bashrc` lines into `~/.bashrc.d/scripts-available/00_default.sh` and enables it immediately.
|
||||
- 🧹 Replaces `~/.bashrc` with the clean, non-intrusive modular loader block.
|
||||
- 📦 Deploys the core logic to `scripts-needed/` and default modules to `scripts-available/`.
|
||||
- 🏷️ Initializes `.version` with the latest Git commit hash.
|
||||
|
||||
---
|
||||
|
||||
## Usage (`brc-script`)
|
||||
## 💻 CLI Reference (`brc-script`)
|
||||
|
||||
The main command-line management tool is `brc-script`.
|
||||
`brc-script` is the central command-line utility for administering your modular configuration.
|
||||
|
||||
### Available Commands
|
||||
### Command Cheat Sheet
|
||||
|
||||
| Command | Alias / Flags | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| **List Scripts** | `brc-script -l` / `--list` | Lists all available scripts and indicates active/enabled status (`-`). |
|
||||
| **Preview / Cat Script** | `brc-script -p` / `--cat <id\|name ...>` | Prints script source code with line numbers and status without opening an editor. |
|
||||
| **Enable Script(s)** | `brc-script -e` / `--enable <id\|name ...>` | Enables one or multiple scripts by numeric ID or name. |
|
||||
| **Disable Script(s)** | `brc-script -d` / `--disable <id\|name ...>` | Disables one or multiple scripts by numeric ID or name. |
|
||||
| **Enable All** | `brc-script -ea` / `--enable-all` | Enables all available scripts. |
|
||||
| **Disable All** | `brc-script -da` / `--disable-all` | Disables all currently enabled scripts. |
|
||||
| **Create Script** | `brc-script -c` / `--create` | Prompts for a name, generates a template, and opens it in your editor. |
|
||||
| **Modify Script** | `brc-script -m` / `--modify <id\|name>` | Opens a script in editor and allows renaming. |
|
||||
| **Remove Script** | `brc-script -r` / `--remove <id\|name ...>` | Moves script(s) to `scripts-removed/` with a timestamp. |
|
||||
| **Check Updates** | `brc-script -u` / `--update` | Queries Gitea repository for latest commits and new updates. |
|
||||
| **Upgrade System** | `brc-script --upgrade` | Upgrades core and default scripts from Gitea (never touches `00_default.sh`). |
|
||||
| **Reload Shell** | `refresh-brc` | Reloads `.bashrc` in current session. |
|
||||
| Action | Flags / Aliases | Arguments | Description |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **List** | `-l`, `--list`, `list` | *none* | Lists all scripts with IDs, names, and active status (`-` in blue) |
|
||||
| **Preview** | `-p`, `-v`, `--cat`, `--show`, `cat` | `<id\|name ...>` | Prints script code with line numbers without opening an editor |
|
||||
| **Enable** | `-e`, `--enable`, `enable` | `<id\|name ...>` | Activates one or more scripts by creating symlinks in `scripts-enabled/` |
|
||||
| **Disable** | `-d`, `--disable`, `disable` | `<id\|name ...>` | Deactivates one or more scripts by removing symlinks |
|
||||
| **Enable All** | `-ea`, `--enable-all`, `enable-all` | *none* | Enables all available scripts at once |
|
||||
| **Disable All** | `-da`, `--disable-all`, `disable-all` | *none* | Disables all enabled scripts at once |
|
||||
| **Create** | `-c`, `--create`, `create` | *none* | Interactive wizard to create a new script template and open it in `$EDITOR` |
|
||||
| **Modify** | `-m`, `--modify`, `modify` | `<id\|name>` | Opens a script in `$EDITOR` (or `vim`) and allows renaming |
|
||||
| **Remove** | `-r`, `--remove`, `remove` | `<id\|name ...>` | Safely moves script(s) to `scripts-removed/` with a timestamp |
|
||||
| **Update** | `-u`, `--update`, `update` | *none* | Queries Gitea repository for new commits/updates |
|
||||
| **Upgrade** | `--upgrade`, `upgrade` | *none* | Safely upgrades core scripts and default modules without altering your custom code |
|
||||
| **Reload** | `refresh-brc` | *none* | Immediately reloads `~/.bashrc` in the current shell session |
|
||||
|
||||
---
|
||||
|
||||
### Command Examples
|
||||
### Usage Examples
|
||||
|
||||
#### 1. Listing scripts
|
||||
#### 1. Listing All Available Modules
|
||||
```bash
|
||||
brc-script -l
|
||||
```
|
||||
|
||||
#### 2. Enabling multiple scripts at once (by ID or Name)
|
||||
```bash
|
||||
# Enable by multiple IDs
|
||||
brc-script -e 1 3 4
|
||||
|
||||
# Enable by script names (with or without .sh)
|
||||
brc-script -e 01_git-cli-highlitgh 03_bashboard
|
||||
*Output preview:*
|
||||
```text
|
||||
------------------------------------
|
||||
Scripts List
|
||||
------------------------------------
|
||||
1) 00_default.sh -
|
||||
2) 01_git-cli-highlitgh.sh
|
||||
3) 02_git-cli-highlitgh-root.sh
|
||||
4) 03_bashboard.sh -
|
||||
5) 04_aliases.sh
|
||||
------------------------------------
|
||||
'-' (blue) = Active / Enabled
|
||||
------------------------------------
|
||||
```
|
||||
|
||||
#### 3. Disabling multiple scripts at once
|
||||
#### 2. Enabling Multiple Scripts in One Command
|
||||
You can pass numbers, names with `.sh`, or names without `.sh`:
|
||||
```bash
|
||||
# Disable multiple IDs
|
||||
brc-script -d 1 5 12 10
|
||||
# Enable by numerical IDs
|
||||
brc-script -e 2 5
|
||||
|
||||
# Disable by name
|
||||
# Enable by script names
|
||||
brc-script -e 01_git-cli-highlitgh 04_aliases
|
||||
```
|
||||
|
||||
#### 3. Disabling Multiple Scripts
|
||||
```bash
|
||||
# Disable by IDs
|
||||
brc-script -d 2 4 5
|
||||
|
||||
# Disable by names
|
||||
brc-script -d 03_bashboard 04_aliases
|
||||
```
|
||||
|
||||
#### 4. Quick viewing / catting script contents
|
||||
#### 4. Previewing Script Code Directly in Terminal
|
||||
Inspect what a script does before enabling it:
|
||||
```bash
|
||||
# Preview by name
|
||||
brc-script -p 03_bashboard
|
||||
# Preview using numeric ID
|
||||
brc-script -p 4
|
||||
|
||||
# Preview by numerical ID
|
||||
brc-script --cat 2
|
||||
# Preview using script name
|
||||
brc-script --cat 03_bashboard
|
||||
```
|
||||
|
||||
#### 5. Checking and applying Gitea updates
|
||||
#### 5. Creating a New Custom Script
|
||||
```bash
|
||||
# Check if new versions or commits are available
|
||||
brc-script --update
|
||||
brc-script -c
|
||||
```
|
||||
Prompts for a script name (e.g. `docker-shortcuts`), sets up a boilerplate header, and opens it directly in `$EDITOR` (or `vim`).
|
||||
|
||||
# Perform safe self-upgrade from Gitea
|
||||
#### 6. Checking and Performing Upgrades
|
||||
```bash
|
||||
# Check if updates are available on Gitea
|
||||
brc-script -u
|
||||
|
||||
# Upgrade core engine and default templates
|
||||
brc-script --upgrade
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Included Default Scripts
|
||||
|
||||
### `00_default.sh` – Personal Configuration & Migration
|
||||
Contains all your original aliases, functions, and environment variables migrated during installation. This file is yours and is never overwritten during upgrades.
|
||||
|
||||
### `01_git-cli-highlitgh.sh` & `02_git-cli-highlitgh-root.sh` – Git Prompt
|
||||
Shows branch name, uncommitted changes, staged files, untracked files, and ahead/behind remote indicators directly in your prompt.
|
||||
|
||||
### `03_bashboard.sh` – Terminal System Dashboard
|
||||
Displays CPU, RAM, disk usage, IP addresses, distro info, uptime, available packages updates, and automatically discovers **Cockpit Web UI** if installed (with dynamic port detection).
|
||||
|
||||
### `04_aliases.sh` – Common Aliases
|
||||
Useful starting aliases such as `alias ls="ls --color"`.
|
||||
> [!NOTE]
|
||||
> `brc-script --upgrade` will **never** overwrite your `00_default.sh` or custom scripts. Only standard upstream modules and `scripts-needed/` utilities are updated.
|
||||
|
||||
---
|
||||
|
||||
## Extra Utilities: `ccecho`
|
||||
## 📦 Included Default Modules
|
||||
|
||||
The project includes `ccecho.sh` in `scripts-needed/` for formatted and colored terminal output.
|
||||
### `00_default.sh` — Your Personal Migrated Configuration
|
||||
- **Purpose:** Houses all your existing aliases, functions, environment variables, and `PATH` exports migrated during installation.
|
||||
- **Safety:** **Strictly protected**. Upgrades will never touch or overwrite this file.
|
||||
|
||||
### `01_git-cli-highlitgh.sh` — Git Status Prompt (User)
|
||||
- **Purpose:** Adds a clean, color-coded Git branch and status indicator to your bash prompt:
|
||||
- Branch name in **Green** (clean) or **Purple** (dirty).
|
||||
- `+N`: Staged files count (Green).
|
||||
- `M:N`: Modified files count (Yellow).
|
||||
- `N:N`: Untracked files count (Red).
|
||||
- `↑N` / `↓N`: Commits ahead / behind remote (Cyan).
|
||||
|
||||
### `02_git-cli-highlitgh-root.sh` — Git Status Prompt (Root / Multi-User)
|
||||
- **Purpose:** High-visibility Git prompt tailored for multi-user/root environments. Displays red alert styling for `root` (`#`) and green/blue for normal users (`>`).
|
||||
|
||||
### `03_bashboard.sh` — Terminal MOTD & Cockpit Discovery
|
||||
- **Purpose:** Displays an interactive system dashboard upon login:
|
||||
- Distro details and Hostname
|
||||
- Local and Public IP addresses
|
||||
- System Uptime & Load
|
||||
- Memory (RAM) & Disk usage with color-coded thresholds
|
||||
- CPU Temperature (with VM detection)
|
||||
- Pending Package Updates count (`apt`, `dnf`, `yum`, `pacman`, `zypper`, `apk`)
|
||||
- **Dynamic Cockpit Web UI Detection:** Detects if Cockpit is installed and running, extracts its listening port from configuration/sockets, and displays the direct URL.
|
||||
|
||||
### `04_aliases.sh` — Essential Aliases
|
||||
- **Purpose:** Handy starting aliases (e.g., colorized directory listings).
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Creating Custom Modules
|
||||
|
||||
Creating your own modular script is simple:
|
||||
|
||||
1. Run the creator wizard:
|
||||
```bash
|
||||
brc-script -c
|
||||
```
|
||||
2. Enter the script name (e.g. `my-docker-tools`).
|
||||
3. Add your custom functions, aliases, and environment variables:
|
||||
|
||||
```bash
|
||||
ccecho -t green -b black -s bold "Success!"
|
||||
ccecho -t red -s underline "Error!"
|
||||
#!/bin/bash
|
||||
# ============================================================
|
||||
# Modular Bashrc - my-docker-tools.sh
|
||||
# ============================================================
|
||||
|
||||
# Custom aliases
|
||||
alias dps="docker ps --format 'table {{.Names}}\t{{.Status}}\t{{.Ports}}'"
|
||||
alias dlogs="docker logs -f --tail=100"
|
||||
|
||||
# Custom function
|
||||
dclean() {
|
||||
ccecho -t byellow "Cleaning unused Docker containers and images..."
|
||||
docker system prune -af --volumes
|
||||
ccecho -t bgreen "Docker cleaned successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
**Text colors:** `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `bblack`, `bred`, `bgreen`, `byellow`, `bblue`, `bmagenta`, `bcyan`, `bwhite`.
|
||||
**Styles:** `bold`, `dim`, `italic`, `underline`, `blink`, `reverse`, `hidden`, `strike`.
|
||||
4. Save and exit the editor.
|
||||
5. Enable your new module:
|
||||
```bash
|
||||
brc-script -e my-docker-tools
|
||||
refresh-brc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Official Repository & Updates
|
||||
## 🎨 Extra Utilities (`ccecho`)
|
||||
|
||||
- **Gitea:** [https://gitea.sld-server.org/sld-admin/Modular-Bashrc-Manager](https://gitea.sld-server.org/sld-admin/Modular-Bashrc-Manager)
|
||||
- **Author:** Simone Cusano ([https://sld-server.org](https://sld-server.org))
|
||||
Modular Bashrc Manager includes `ccecho`, a high-performance ANSI text formatting helper located in `scripts-needed/ccecho.sh`. You can use it in any of your custom scripts:
|
||||
|
||||
```bash
|
||||
ccecho -t green -s bold "Operation succeeded!"
|
||||
ccecho -t red -b black -s underline "Fatal Error: Connection refused"
|
||||
```
|
||||
|
||||
### Available Options:
|
||||
- **Text Colors (`-t` / `--text`):**
|
||||
`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`
|
||||
*Bright variants:* `bblack`, `bred`, `bgreen`, `byellow`, `bblue`, `bmagenta`, `bcyan`, `bwhite`
|
||||
- **Background Colors (`-b` / `--bg`):**
|
||||
`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`
|
||||
*Bright variants:* `bblack`, `bred`, `bgreen`, `byellow`, `bblue`, `bmagenta`, `bcyan`, `bwhite`
|
||||
- **Text Styles (`-s` / `--style`):**
|
||||
`bold`, `dim`, `italic`, `underline`, `blink`, `reverse`, `hidden`, `strike`
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
## 🐧 Supported Distributions
|
||||
|
||||
This project is licensed under the GNU General Public License v3.0.
|
||||
Modular Bashrc Manager has been tested and includes native package detection for:
|
||||
|
||||
| Family | Distributions / Systems | Package Manager |
|
||||
| :--- | :--- | :--- |
|
||||
| **Debian** | Debian, Ubuntu, Linux Mint, Pop!_OS, Raspberry Pi OS | `apt` / `apt-get` |
|
||||
| **Red Hat** | Fedora, RHEL, CentOS, Rocky Linux, AlmaLinux | `dnf` / `yum` |
|
||||
| **Arch** | Arch Linux, Manjaro, EndeavourOS | `pacman` |
|
||||
| **SUSE** | openSUSE Leap, openSUSE Tumbleweed | `zypper` |
|
||||
| **Alpine** | Alpine Linux (containers & servers) | `apk` |
|
||||
| **macOS** | Apple macOS (Intel & Apple Silicon) | `brew` (Homebrew) |
|
||||
|
||||
---
|
||||
|
||||
## ❓ Troubleshooting & FAQ
|
||||
|
||||
### 1. I enabled a script, but new commands aren't working yet!
|
||||
Run the reload command in your terminal:
|
||||
```bash
|
||||
refresh-brc
|
||||
```
|
||||
*(Or restart your terminal session).*
|
||||
|
||||
### 2. How do I restore my original `.bashrc`?
|
||||
The installer automatically creates a timestamped backup before touching anything. To restore:
|
||||
```bash
|
||||
cp ~/bashrc-backup-* ~/.bashrc
|
||||
```
|
||||
|
||||
### 3. Where are removed scripts stored?
|
||||
When you delete a script with `brc-script -r <id|name>`, it is never permanently deleted; it is timestamped and safely placed in:
|
||||
```text
|
||||
~/.bashrc.d/scripts-removed/
|
||||
```
|
||||
|
||||
### 4. How can I change the default text editor for `brc-script`?
|
||||
Set the `EDITOR` environment variable in your `00_default.sh`:
|
||||
```bash
|
||||
export EDITOR="nano" # or "code", "vim", "nvim", "micro"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📄 License & Author
|
||||
|
||||
- **Author:** Simone Cusano ([sld-server.org](https://sld-server.org))
|
||||
- **Repository:** [https://gitea.sld-server.org/sld-admin/Modular-Bashrc-Manager](https://gitea.sld-server.org/sld-admin/Modular-Bashrc-Manager)
|
||||
- **License:** GNU General Public License v3.0 ([GPL-3.0](LICENSE))
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<sub>Made with ❤️ by <a href="https://sld-server.org">Simone Cusano</a>. If you find this project helpful, feel free to star and share it!</sub>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user