Rename Directory Utility - Quick Reference¶

Basic Usage¶

~/github/scripts/rename-directory.sh <source> <target>

Common Examples¶

Rename a Project¶

~/github/scripts/rename-directory.sh ~/github/old-project ~/github/new-project

Rebrand Application¶

~/github/scripts/rename-directory.sh ~/github/posthog ~/github/bashog

Reorganize Workspace¶

~/github/scripts/rename-directory.sh ~/projects/legacy-app ~/projects/app-v2

Pre-Flight Checklist¶

✅ Source directory exists ✅ Target directory doesn't exist ✅ Parent directory has write permissions ✅ Related Docker containers are identified ✅ Git repository status is checked ✅ Uncommitted changes are reviewed

Interactive Prompts¶

Stop Docker containers? (if found)
Recommended: yes
Continue with uncommitted changes? (if found)
Review changes first
Commit or stash changes if possible
Create backup?
Recommended: yes (especially for important projects)
Backup location: <source>-backup-YYYYMMDD-HHMMSS

What Gets Preserved¶

✅ Git repository and history ✅ File permissions and ownership ✅ Directory structure ✅ All file contents ✅ Hidden files (.git, .env, etc.)

Post-Rename Actions¶

VS Code¶

Close workspace
Open new location: code <new-path>

Terminal Sessions¶

cd <new-path>

Git Remote URLs (if applicable)¶

cd <new-path>
git remote set-url origin <new-repository-url>

Docker Containers¶

# Rebuild with new name
docker-compose up --build -d

Common Issues¶

"Target directory already exists"¶

# Remove or rename existing target
rm -rf <target-path>  # OR
mv <target-path> <target-path>-old

"Permission denied"¶

# Check directory permissions
ls -la $(dirname <source-path>)
ls -la $(dirname <target-path>)

Git repository issues¶

# Check git status first
cd <source-path>
git status

# Commit changes
git add .
git commit -m "Checkpoint before rename"

Backup Management¶

Check backup size¶

du -sh <backup-directory>

Remove backup (after verification)¶

rm -rf <backup-directory>

Restore from backup (if needed)¶

rm -rf <target-path>
mv <backup-directory> <source-path>

Safety Features¶

🔒 Won't overwrite existing directories 🔒 Checks permissions before proceeding 🔒 Preserves git history and configuration 🔒 Stops Docker containers to prevent conflicts 🔒 Warns about uncommitted changes 🔒 Verifies successful rename

Tips¶

Always create a backup for production or important projects
Commit git changes before renaming
Close IDEs and terminals in the source directory
Update environment variables after rename
Test thoroughly after rename

Getting Help¶

~/github/scripts/rename-directory.sh --help

Return Codes¶

0 - Success
1 - Error (check error message for details)

Tip: Add the scripts directory to your PATH for easier access:

echo 'export PATH="$PATH:~/github/scripts"' >> ~/.zshrc
source ~/.zshrc
# Then use: rename-directory.sh <source> <target>