executing_scripts.md

Adding Bash Scripts to PATH - Complete Guide

Method 1: Using ~/bin Directory (Recommended)

Step 1: Create a bin directory in your home folder

mkdir -p ~/bin

Step 2: Move your scripts to the bin directory

# Move individual script
mv your-script.sh ~/bin/

# Or move multiple scripts
mv script1.sh script2.sh script3.sh ~/bin/

Step 3: Make scripts executable

chmod +x ~/bin/*.sh

Step 4: Add ~/bin to your PATH

Add this line to your shell configuration file:

For Bash (add to ~/.bashrc or ~/.bash_profile):

export PATH="$HOME/bin:$PATH"

For Zsh (add to ~/.zshrc):

export PATH="$HOME/bin:$PATH"

Step 5: Reload your shell configuration

# For Bash
source ~/.bashrc
# or
source ~/.bash_profile

# For Zsh
source ~/.zshrc

Step 6: Remove file extensions (optional)

For cleaner command names, remove the .sh extension:

cd ~/bin
mv script-name.sh script-name

Method 2: Using /usr/local/bin (System-wide)

Step 1: Move scripts to system directory

sudo mv your-script.sh /usr/local/bin/

Step 2: Make executable

sudo chmod +x /usr/local/bin/your-script.sh

Step 3: Remove extension (optional)

sudo mv /usr/local/bin/your-script.sh /usr/local/bin/your-script

Note: /usr/local/bin is typically already in PATH, so no additional configuration needed.

Method 3: Using Custom Directory

Step 1: Create your custom scripts directory

mkdir -p ~/scripts
# or
mkdir -p ~/my-tools

Step 2: Move and make scripts executable

mv *.sh ~/scripts/
chmod +x ~/scripts/*.sh

Step 3: Add custom directory to PATH

Add to your shell configuration file:

export PATH="$HOME/scripts:$PATH"

Step 4: Reload configuration

source ~/.bashrc  # or ~/.zshrc

Best Practices

1. Script Naming

• Use descriptive names: git-fetch-all instead of fetch.sh
• Remove .sh extension for cleaner commands
• Use hyphens instead of underscores: my-script not my_script

2. Script Structure

Always start your scripts with a shebang:

#!/bin/bash

3. File Permissions

Make sure scripts are executable:

chmod +x script-name

4. Testing

Test that your script is accessible:

which script-name
script-name --help

Managing Multiple Scripts

Create a dedicated repository

mkdir -p ~/dotfiles/bin
cd ~/dotfiles/bin
# Move all your scripts here

Use symlinks (advanced)

# Create symlinks in ~/bin pointing to your scripts repo
ln -s ~/dotfiles/bin/script-name ~/bin/script-name

Organize by category

mkdir -p ~/bin/git-tools
mkdir -p ~/bin/dev-tools
mkdir -p ~/bin/system-tools

Quick Setup Commands

Complete setup for ~/bin method:

# Create directory
mkdir -p ~/bin

# Add to PATH (choose your shell)
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc   # For Bash
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc    # For Zsh

# Reload configuration
source ~/.bashrc  # or ~/.zshrc

# Move and setup scripts
mv your-script.sh ~/bin/your-script
chmod +x ~/bin/your-script

Verification

Check if everything works:

# Check if directory is in PATH
echo $PATH | grep -o ~/bin

# List all executable scripts
ls -la ~/bin

# Test script accessibility
which your-script-name

Troubleshooting

Script not found after adding to PATH

• Restart terminal or run source ~/.bashrc
• Check if script is executable: ls -la ~/bin/script-name
• Verify PATH contains your directory: echo $PATH

Permission denied

chmod +x ~/bin/script-name

Command not found

• Check script name and location
• Ensure no typos in PATH export
• Try absolute path first: ~/bin/script-name