Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/programming-sai/bash-scripts-toolkit

A collection of Bash scripts for automating various tasks. This repository contains reusable scripts for system management, development workflows, and other common automation needs. Perfect for saving time and improving productivity when working on new projects.
https://github.com/programming-sai/bash-scripts-toolkit

automation bash dev-tools development productivity scripts

Last synced: 15 days ago
JSON representation

Host: GitHub
URL: https://github.com/programming-sai/bash-scripts-toolkit
Owner: Programming-Sai
Created: 2025-01-21T07:30:25.000Z (23 days ago)
Default Branch: main
Last Pushed: 2025-01-23T06:27:26.000Z (21 days ago)
Last Synced: 2025-01-29T17:14:56.336Z (15 days ago)
Topics: automation, bash, dev-tools, development, productivity, scripts
Language: Shell
Homepage:
Size: 15.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Bash-Scripts-Toolkit

A collection of Bash scripts designed to automate and simplify common tasks for system management, development workflows, and other automation needs. These scripts are reusable and ideal for saving time and improving productivity when working on projects.

---

## Features

- Automate repetitive tasks with ease.
- Simplify Git workflows and project management.
- Manage Python dependencies and deployments.
- Customizable and reusable for various use cases.

---

## Installation

1. **Clone the repository:**

```bash
git clone https://github.com/Programming-Sai/Bash-Scripts-Toolkit.git
cd Bash-Scripts-Toolkit
```

2. **Make scripts executable:**

```bash
chmod +x *.sh
```

---

## How to Use the Scripts

Each script is designed for a specific task. Below is a detailed description of each script:

### **1. Remove Folder from Git and Add to `.gitignore`**

- **File Name:** `removeFileFromGitRemotelyOnly.sh`
- **Description:**
This script removes a folder from Git tracking, optionally adds it to `.gitignore`, and pushes the changes to the remote repository.
- **Usage:**
```bash
./removeFileFromGitRemotelyOnly.sh [-g]
```
- ``: Name of the folder to remove.
- `-g`: Optional flag to add the folder to `.gitignore`.

---

### **2. Git Add, Commit, Push, Build, and Deploy**

- **File Name:** `ghPagesDeploy.sh`
- **Description:**
Automates Git commit and push operations along with building and deploying a project (e.g., an npm-based project).
- **Usage:**

```bash
./ghPagesDeploy.sh "" ""
```

- If no arguments are provided, defaults to "Made some modifications" for the Git commit message.

> [!NOTE]
> In your `package.json` file, in the `scripts` section, it must look something like this.

```json
"scripts": {
"dev": "",
"build": "",
"preview": "",
"predeploy": "npm run build",
"deploy": "gh-pages -d -b -m \"${npm_config_message:-Updates}\""
},
```

> also, you must have `gh-pages` installed as a devDependency, like this:

```bash
npm install gh-pages --save-dev
```

---

### **3. Install Python Dependencies and Update `requirements.txt`**

- **File Name:** `pipInstall.sh`
- **Description:**
Installs the specified Python packages, updates `requirements.txt`, and ensures the project dependencies are tracked.
- **Usage:**
```bash
./pipInstall.sh [other_packages]
```
- If no package names are provided, prompts the user to supply them.

---

### **4. Simple Git Commit and Push**

- **File Name:** `gitAll.sh`
- **Description:**
Adds all changes, commits with a specified message, and pushes to the remote repository.
- **Usage:**
```bash
./gitAll.sh ""
```
- Prompts for a commit message if not provided.

---

Here's how you can format the new section for your tool using the provided format:

---

### **5. Git Project Setup Tool**

- **File Name:** `gitProjectSetup.sh`
- **Description:**
Clones a GitHub repository into a specified directory (or default to `~/Desktop`), opens it in Visual Studio Code, and handles directory creation if it doesn't exist. Includes error handling for invalid URLs and cloning failures.
- **Usage:**

```bash
./gitProjectSetup.sh []
```

- ``: The GitHub repository URL to clone.
- `` (Optional): The target directory for the clone. If not provided, defaults to `~/Desktop`.

- **Example:**
1. Clone to the default directory (Desktop):
```bash
./gitProjectSetup.sh https://github.com//.git
```
2. Clone to a custom directory:
```bash
./gitProjectSetup.sh https://github.com//.git ~/Projects
```
3. Clone to a non-existing directory (the directory will be created automatically):
```bash
./gitProjectSetup.sh https://github.com//.git ~/NonExistentFolder
```

---

### **6. Create and Activate Python Virtual Environments**

- **File Name:** `pythonVenv.sh`
- **Description:**
Creates a Python virtual environment in the specified directory or defaults to `.venv` if no directory is provided. The script also outputs instructions for activating the virtual environment manually since activation cannot persist across script executions.
- **Usage:**

```bash
source ./pythonVenv.sh
```

- If `` is not provided, the virtual environment will be created in `.venv`.

---

### **7. Globalizing Bash Scripts**

#### **Script Name:** `globalize.sh`

Make any Bash script globally executable from anywhere on your system by adding it to `/usr/local/bin`.

#### **Usage:**

```bash
./globalize.sh
```

- **``:** Path to the script you want to globalize.

#### **Example:**

1. Create `hello.sh`:
```bash
echo "Hello, World!"
```
2. Run:
```bash
./globalize.sh hello.sh
```
3. Use globally:
```bash
hello
```
Output: `Hello, World!`

---

#### **Notes:**

- Requires `sudo` privileges for `/usr/local/bin`.
- Handles conflicts if a script with the same name exists.

---

## Why These Scripts Exist

1. **Efficiency:**
Save time by automating repetitive tasks, especially in development workflows.
2. **Reusability:**
Easily adapt and reuse the scripts in new projects without recreating them.
3. **Consistency:**
Enforce consistent practices across projects and avoid human errors in critical operations.

---

## Adding New Scripts

If you write additional scripts, place them in the repository and update the README with:

- **File Name**
- **Description**
- **Usage Instructions**

---

## Contributions

Feel free to fork, modify, and contribute improvements! Open a pull request with detailed descriptions of your changes.

---