particle-os-tools/SCRIPT_INVENTORY.md

2.7 KiB

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. Mimicks rpm-ostree but for deb packages. (compiled from scriptlets, now supports atomic OSTree commits and robust overlay/dpkg install with official ComposeFS tools)
  • composefs-alternative.sh - ComposeFS management tool (archived; official ComposeFS tools are now default)
  • bootc-alternative.sh - BootC management tool (compiled from scriptlets)
  • bootupd-alternative.sh - BootUpd management tool (compiled from scriptlets)
  • ../orchestrator/orchestrator.sh - Main orchestrator for all tools (moved to orchestrator directory)
  • 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 (ARCHIVED)

All fix and test scripts have been moved to archive/ for historical reference. The workspace is now clean and only contains essential scripts for development and deployment.

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:

  • All old test scripts and fix scripts
  • Previous versions of tools
  • Deprecated integration scripts
  • Backup files