robojerk/particle-os-tools
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
particle-os-tools/SCRIPT_INVENTORY.md
robojerk 74c7bede5f Initial commit: Particle-OS tools repository 
- Complete Particle-OS rebranding from uBlue-OS
- Professional installation system with standardized paths
- Self-initialization system with --init and --reset commands
- Enhanced error messages and dependency checking
- Comprehensive testing infrastructure
- All source scriptlets updated with runtime improvements
- Clean codebase with redundant files moved to archive
- Complete documentation suite
2025-07-11 21:14:33 -07:00

4.4 KiB
Raw Blame History

Particle-OS Script Inventory

This document catalogs all scripts in the tools directory and their purposes.

Core Scripts (KEEP)

Main Tools

  • apt-layer.sh - Main apt-layer tool (compiled from scriptlets)
  • composefs-alternative.sh - ComposeFS management tool (compiled from scriptlets)
  • bootc-alternative.sh - BootC management tool (compiled from scriptlets)
  • bootupd-alternative.sh - BootUpd management tool (compiled from scriptlets)
  • orchestrator.sh - Main orchestrator for all tools
  • particle-config.sh - Configuration file for all tools
  • particle-logrotate.sh - Log rotation configuration
  • oci-integration.sh - OCI container integration

Installation & Setup

  • install-particle-os.sh - Main installation script for Particle-OS tools
  • dev-install.sh - Development installation helper
  • install-ubuntu-particle.sh - Ubuntu-specific installation
  • dracut-module.sh - Dracut module for boot integration

Testing

  • test-particle-os-system.sh - Comprehensive system testing script
  • test-all-compiled-scripts.sh - Test all compiled scripts
  • test-installation.sh - Test installation functionality

Documentation

  • README.md - Main project documentation
  • INSTALLATION.md - Installation guide
  • TROUBLESHOOTING_GUIDE.md - Troubleshooting guide
  • WINDOWS-COMPILATION.md - Windows compilation guide
  • TODO.md - Project TODO list
  • COMPILATION_STATUS.md - Compilation status tracking

Windows Support

  • compile-windows.bat - Windows batch compilation script
  • compile-windows.ps1 - Windows PowerShell compilation script

Redundant Fix Scripts (MOVE TO ARCHIVE)

These scripts were created during development to fix specific issues but are now redundant:

Permission Fixes

  • fix-system-permissions.sh - Fixed system permissions (redundant)
  • fix-apt-layer-permissions.sh - Fixed apt-layer permissions (redundant)
  • fix-apt-layer-permissions-final.sh - Final apt-layer permission fix (redundant)
  • fix-permissions-complete.sh - Complete permission fix (redundant)

Function Fixes

  • fix-missing-functions.sh - Fixed missing functions (redundant)
  • fix-remaining-tools.sh - Fixed remaining tools (redundant)
  • fix-all-particle-tools.sh - Fixed all tools (redundant)

Configuration Fixes

  • fix-config.sh - Fixed configuration (redundant)
  • fix-config-better.sh - Better configuration fix (redundant)
  • create-clean-config.sh - Created clean config (redundant)
  • restore-config.sh - Restored configuration (redundant)
  • setup-directories.sh - Setup directories (redundant)

Help Fixes

  • fix-help-syntax.sh - Fixed help syntax (redundant)
  • final-help-fix.sh - Final help fix (redundant)
  • comprehensive-fix.sh - Comprehensive fix (redundant)

Quick Fixes

  • quick-fix-particle-os.sh - Quick fix (redundant)

Testing Scripts

  • test-source-logging.sh - Test source logging (redundant)
  • test-source-logging-fixed.sh - Test fixed source logging (redundant)
  • test-logging-functions.sh - Test logging functions (redundant)
  • test-line-endings.sh - Test line endings (redundant)
  • dos2unix.sh - Convert line endings (redundant)

Source Code (KEEP)

Source Directories

  • src/apt-layer/ - apt-layer source scriptlets
  • src/composefs/ - composefs source scriptlets
  • src/bootc/ - bootc source scriptlets
  • src/bootupd/ - bootupd source scriptlets
  • src/mac-support/ - macOS support scripts

Documentation

  • docs/ - Project documentation

Infrastructure

  • infrastructure/ - Infrastructure planning documents

Containers

  • containers/ - Container definitions

Archive (ALREADY ARCHIVED)

The archive directory contains:

  • Old test scripts
  • Previous versions of tools
  • Deprecated integration scripts
  • Backup files

Cleanup Actions Required

  1. Move redundant fix scripts to archive/
  2. Update documentation to reflect current state
  3. Remove references to archived scripts from documentation
  4. Keep only the essential scripts for development and deployment

Essential Scripts for Development

For development work, you only need:

  • Source scriptlets in src/ directories
  • Compilation scripts in each src/ directory
  • Main compiled tools (apt-layer.sh, etc.)
  • Installation scripts
  • Testing scripts
  • Documentation

All fix scripts can be safely archived as their fixes have been incorporated into the source scriptlets.