Skip to content

Home

Jump to bottom
Mikhail Deynekin edited this page Dec 23, 2025 · 5 revisions

Clean BOM Senior - Professional Wiki

🎯 Welcome to Clean BOM Senior!

This is the comprehensive documentation hub for Clean BOM Senior, a professional-grade utility for removing Byte Order Mark (BOM) encoding artifacts from text files across multiple file types.

Whether you're a developer, system administrator, or DevOps engineer, you'll find everything you need to master this powerful tool.

📚 Documentation Structure

Our documentation is organized into focused learning paths:

🚀 Quick Start (5-15 minutes)

  • Quick Start Guide — Installation, first run, and basic examples
  • Get up and running in minutes with step-by-step instructions

📖 Core Concepts (30-45 minutes)

🔧 Reference (10-20 minutes per section)

  • Command-Line Reference — Complete CLI documentation
  • All flags, options, and parameters explained with examples

🔌 Integration (20-30 minutes)

  • CI/CD Integration Guide — Automate BOM removal in your pipeline
  • GitHub Actions, GitLab CI, Jenkins, Docker examples

🆘 Support

  • Troubleshooting Guide — Solutions to common issues
  • Diagnostic tools and error resolution
  • FAQ — 40+ frequently asked questions
  • Quick answers to common questions
  • Full Index — Complete sitemap and search guide

🎓 Choose Your Learning Path

Path 1: Developer (15 minutes)

You just want to use the tool quickly:

  1. Read Quick Start Guide
  2. Skim Command-Line Reference
  3. Bookmark Troubleshooting Guide for later

Path 2: DevOps/Team Lead (1-2 hours)

You need complete understanding:

  1. Complete Quick Start Guide
  2. Deep-dive Understanding BOM and CRLF
  3. Study File Types and Detection
  4. Master CI/CD Integration Guide

Path 3: Administrator (1-2 hours)

You manage multiple environments:

  1. Start Understanding BOM and CRLF
  2. Review File Types and Detection
  3. Implement CI/CD Integration Guide
  4. Archive Troubleshooting Guide

Path 4: Complete Mastery (2-3 hours)

You want to know everything:

  1. Complete all sections in order
  2. Practice examples from each guide
  3. Explore advanced scenarios in FAQ
  4. Bookmark this Wiki for reference

🔍 What is Clean BOM Senior?

Clean BOM Senior is a robust, production-ready shell script that:

✅ Removes BOM encodings from text files (UTF-8 BOM, UTF-16, UTF-32)
✅ Handles CRLF line endings properly and safely
✅ Auto-detects file types for intelligent processing
✅ Supports 50+ file extensions with type-specific rules
✅ Batch processes directories recursively
✅ Provides detailed reporting of changes made
✅ Creates backups for safety and recovery
✅ Cross-platform compatible (Linux, macOS, WSL)
✅ CI/CD ready with exit codes and automation support
✅ Well-documented with 150+ code examples

💡 Common Use Cases

Issue: Files exported from Windows have BOM

Solution: Run clean-bom-senior.sh on the directory. See Quick Start Guide.

Issue: Git shows encoding issues

Solution: Use --fix-gitattributes flag. See Troubleshooting Guide.

Issue: Need to automate in CI pipeline

Solution: Use GitHub Actions integration. See CI/CD Integration Guide.

Issue: Different file types need different handling

Solution: Clean BOM Senior auto-detects. See File Types and Detection.

🆘 Need Help?

Quick answers? → Check FAQ
Something not working? → Visit Troubleshooting Guide
Looking for a specific command? → Browse Command-Line Reference
Want to understand the concept? → Read Understanding BOM and CRLF
Getting started? → Follow Quick Start Guide

📊 Documentation Statistics

  • 9 comprehensive pages covering all aspects
  • 150+ code examples ready to copy-paste
  • 30+ reference tables for quick lookup
  • 40+ FAQ entries answering common questions
  • 12 troubleshooting solutions with diagnostics
  • 5 CI/CD platform integrations (GitHub, GitLab, Jenkins, Docker, Make)
  • 100+ cross-references for easy navigation

🚀 Next Steps

New to Clean BOM Senior?
→ Start with Quick Start Guide (5 minutes)

Want to understand BOM better?
→ Read Understanding BOM and CRLF (15 minutes)

Need to integrate with your CI/CD?
→ Check CI/CD Integration Guide (20 minutes)

Looking for something specific?
→ Search in INDEX or use the search box above

📋 Quick Links

Resource Purpose Time
Quick Start Guide Get running fast 5 min
Understanding BOM and CRLF Learn concepts 15 min
File Types and Detection Know file handling 20 min
Command-Line Reference Explore all features 30 min
CI/CD Integration Guide Automate workflow 25 min
Troubleshooting Guide Fix issues As needed
FAQ Quick answers 5-10 min
INDEX Full navigation Reference

⭐ Key Features at a Glance

# Remove BOM from all files in directory
./clean-bom-senior.sh /path/to/directory

# Dry-run to preview changes
./clean-bom-senior.sh --dry-run /path/to/directory

# Include backup files
./clean-bom-senior.sh --backup /path/to/directory

# Process specific file type
./clean-bom-senior.sh --file-type text /path/to/directory

# Verbose reporting
./clean-bom-senior.sh --verbose /path/to/directory

For complete reference: Command-Line Reference

📞 Support & Resources

Last updated: 2025
Clean BOM Senior — Professional Documentation

Clone this wiki locally